diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 151 |
1 files changed, 84 insertions, 67 deletions
@@ -1,87 +1,104 @@ - BIRD Internet Routing Daemon + BIRD Internet Routing Daemon - Mailing list bird-users@network.cz - http://bird.network.cz/mailman/listinfo/bird-users + Home page http://bird.network.cz/ + Mailing list bird-users@network.cz - Home page http://bird.network.cz/ - - (c) 1998--2008 Martin Mares <mj@ucw.cz> + (c) 1998--2008 Martin Mares <mj@ucw.cz> (c) 1998--2000 Pavel Machek <pavel@ucw.cz> (c) 1998--2008 Ondrej Filip <feela@network.cz> - (c) 2009--2013 CZ.NIC z.s.p.o. + (c) 2009--2016 CZ.NIC z.s.p.o. ================================================================================ -The BIRD project is an attempt to create a routing daemon running on UNIX-like -systems (but not necessarily limited to them) with full support of all modern -routing protocols, easy to use configuration interface and powerful route -filtering language. - -If you want to help us debugging, enhancing and porting BIRD or just lurk -around to see what's going to develop from this strange creature, feel free to -subscribe to the BIRD users mailing list (bird-users@bird.network.cz), send -subscribes to majordomo at the same machine). Bug reports, suggestions, feature -requests (: and code :) are welcome. We don't use gitlab issues reporting, sorry. +The BIRD project aims to develop a dynamic IP routing daemon with full support +of all modern routing protocols, easy to use configuration interface and +powerful route filtering language, primarily targeted on (but not limited to) +Linux and other UNIX-like systems and distributed under the GNU General +Public License. -You can download the latest version from ftp://bird.network.cz/pub/bird/ -and look at the BIRD home page at http://bird.network.cz/. +What do we support +================== -BIRD development started as a student project at the Faculty of Math -and Physics, Charles University, Prague, Czech Republic under supervision -of RNDr. Libor Forst <forst@cuni.cz>. BIRD has been developed and supported -by CZ.NIC z.s.p.o. http://www.nic.cz/ since 2009. - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. + o Both IPv4 and IPv6 (use --enable-ipv6 when configuring) + o Multiple routing tables + o Border Gateway Protocol (BGPv4) + o Routing Information Protocol (RIPv2) + o Open Shortest Path First protocol (OSPFv2, OSPFv3) + o Bidirectional Forwarding Detection (BFD) + o IPv6 router advertisements + o Static routes + o Inter-table protocol + o Command-line interface allowing on-line control and inspection of + status of the daemon + o Soft reconfiguration, no need to use complex online commands to + change the configuration, just edit the configuration file and notify + BIRD to re-read it and it will smoothly switch itself to the new + configuration, not disturbing routing protocols unless they are + affected by the configuration changes + o Powerful language for route filtering, see doc/bird.conf.example + o Linux, FreeBSD, NetBSD and OpenBSD ports + +How to install BIRD +=================== + + o From standard distribution package of your OS (recommended) + o From source code of the latest stable release version + ftp://bird.network.cz/pub/bird/ + o From source code of the actual development version + https://gitlab.labs.nic.cz/labs/bird + +How to compile BIRD from source code +------------------------------------ + + $ ./configure + $ make + $ sudo make install + $ sudo vi /usr/local/etc/bird.conf + $ bird + +Documentation +============= + +Online documentation is available at http://bird.network.cz/?get_doc or as HTML +files in the doc directory, you can install it by `make install-docs' and +rebuild it by `make docs', but you'll need SGMLtools and LaTeX to be installed +on your machine. You can also download a neatly formatted PostScript version as +a separate archive (bird-doc-*.tar.gz) from ftp://bird.network.cz/pub/bird/ + +User support +============ - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. +If you want to help us debugging, enhancing and porting BIRD or just lurk +around to see what's going to develop, feel free to subscribe to the BIRD users +mailing list bird-users@bird.network.cz, just send `subscribe bird-users' to +majordomo@network.cz. Bug reports, suggestions, feature requests and code are +welcome! We don't use gitlab issues for reporting, sorry. - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +Licence +======= +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. -How to install BIRD: +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. - ./configure - make - make install - vi /usr/local/etc/bird.conf +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -Online documentation is available as HTML files in the doc directory, -you can install it by `make install-docs' and rebuild it by `make docs', -but for the latter you need SGMLtools and LaTeX to be installed on your -machine. You can also download a neatly formatted PostScript version -as a separate archive (bird-doc-*.tar.gz). +History +======= -What do we support: +BIRD development started as a student project at the Faculty of Math +and Physics, Charles University, Prague, Czech Republic under supervision +of RNDr. Libor Forst <forst@cuni.cz>. BIRD has been developed and supported +by CZ.NIC z.s.p.o. http://www.nic.cz/ since 2009. - o Both IPv4 and IPv6 (use --enable-ipv6 when configuring) - o Multiple routing tables - o BGP - o RIP - o OSPF - o Static routes - o Inter-table protocol - o IPv6 router advertisements - o Bidirectional Forwarding Detection (BFD) - o Command-line interface (using the `birdc' client; to get - some help, just press `?') - o Soft reconfiguration -- no online commands for changing the - configuration in very limited ways, just edit the configuration - file and issue a `configure' command or send SIGHUP and BIRD - will start using the new configuration, possibly restarting - protocols affected by the configuration changes. - o Powerful language for route filtering (see doc/bird.conf.example). - -What is missing: - - o See the TODO list Good Luck and enjoy the BIRD :) The BIRD Team |