README

   1                        BIRD Internet Routing Daemon
   2
   3                      Home page  http://bird.network.cz/
   4                   Mailing list  bird-users@network.cz
   5
   6                 (c) 1998--2008  Martin Mares <mj@ucw.cz>
   7                 (c) 1998--2000  Pavel Machek <pavel@ucw.cz>
   8                 (c) 1998--2008  Ondrej Filip <feela@network.cz>
   9                 (c) 2009--2019  CZ.NIC z.s.p.o.
  10
  11 ================================================================================
  12
  13 The BIRD project aims to develop a dynamic IP routing daemon with full support
  14 of all modern routing protocols, easy to use configuration interface and
  15 powerful route filtering language, primarily targeted on (but not limited to)
  16 Linux and other UNIX-like systems and distributed under the GNU General
  17 Public License.
  18
  19 What do we support
  20 ==================
  21
  22         o  Both IPv4 and IPv6
  23         o  Multiple routing tables
  24         o  Border Gateway Protocol (BGPv4)
  25         o  Routing Information Protocol (RIPv2, RIPng)
  26         o  Open Shortest Path First protocol (OSPFv2, OSPFv3)
  27         o  Babel Routing Protocol (Babel)
  28         o  Bidirectional Forwarding Detection (BFD)
  29         o  IPv6 router advertisements
  30         o  Static routes
  31         o  Inter-table protocol
  32         o  Command-line interface allowing on-line control and inspection of
  33            status of the daemon
  34         o  Soft reconfiguration, no need to use complex online commands to
  35            change the configuration, just edit the configuration file and notify
  36            BIRD to re-read it and it will smoothly switch itself to the new
  37            configuration, not disturbing routing protocols unless they are
  38            affected by the configuration changes
  39         o  Powerful language for route filtering, see doc/bird.conf.example
  40         o  Linux, FreeBSD, NetBSD and OpenBSD ports
  41
  42 How to install BIRD
  43 ===================
  44
  45         o  From standard distribution package of your OS (recommended)
  46         o  From official binary packages for Debian and Red Hat Linux
  47            ftp://bird.network.cz/pub/bird/debian/
  48            ftp://bird.network.cz/pub/bird/redhat/
  49         o  From source code of the latest stable release version
  50            ftp://bird.network.cz/pub/bird/
  51         o  From current development code in Git repository
  52            https://gitlab.labs.nic.cz/labs/bird/
  53
  54 See the file INSTALL for information about installation from source code.
  55
  56 Documentation
  57 =============
  58
  59 Online documentation is available at http://bird.network.cz/?get_doc or as HTML
  60 files in the doc directory, you can install it by `make install-docs' and
  61 rebuild it by `make docs', but you'll need SGMLtools and LaTeX to be installed
  62 on your machine. You can also download a neatly formatted PDF version as
  63 a separate archive (bird-doc-*.tar.gz) from ftp://bird.network.cz/pub/bird/
  64
  65 User support
  66 ============
  67
  68 If you want to help us debugging, enhancing and porting BIRD or just lurk
  69 around to see what's going to develop, feel free to subscribe to the BIRD
  70 users mailing list bird-users@network.cz, just send `subscribe' to
  71 bird-request@network.cz. Bug reports, suggestions, feature requests and
  72 code are welcome! We don't use gitlab issues for reporting, sorry.
  73
  74 Subscribe:      http://bird.network.cz/mailman/listinfo/bird-users/
  75 Archive:        http://bird.network.cz/pipermail/bird-users/
  76
  77 Licence
  78 =======
  79
  80 This program is free software; you can redistribute it and/or modify
  81 it under the terms of the GNU General Public License as published by
  82 the Free Software Foundation; either version 2 of the License, or
  83 (at your option) any later version.
  84
  85 This program is distributed in the hope that it will be useful,
  86 but WITHOUT ANY WARRANTY; without even the implied warranty of
  87 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  88 GNU General Public License for more details.
  89
  90 You should have received a copy of the GNU General Public License
  91 along with this program; if not, write to the Free Software
  92 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  93
  94 History
  95 =======
  96
  97 BIRD development started as a student project at the Faculty of Math
  98 and Physics, Charles University, Prague, Czech Republic under supervision
  99 of RNDr. Libor Forst <forst@cuni.cz>. BIRD has been developed and supported
 100 by CZ.NIC z.s.p.o. http://www.nic.cz/ since 2009.
 101
 102
 103 Good Luck and enjoy the BIRD :)
 104                                                 The BIRD Team