README 4.08 KB
Newer Older
Pavel Tvrdik's avatar
Pavel Tvrdik committed
1
                       BIRD Internet Routing Daemon
2

Pavel Tvrdik's avatar
Pavel Tvrdik committed
3 4
                     Home page  http://bird.network.cz/
                  Mailing list  bird-users@network.cz
5

Pavel Tvrdik's avatar
Pavel Tvrdik committed
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

================================================================================

Pavel Tvrdik's avatar
Pavel Tvrdik committed
13 14 15 16 17
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.
18

Pavel Tvrdik's avatar
Pavel Tvrdik committed
19 20
What do we support
==================
21

22
	o  Both IPv4 and IPv6
Pavel Tvrdik's avatar
Pavel Tvrdik committed
23 24
	o  Multiple routing tables
	o  Border Gateway Protocol (BGPv4)
Ondřej Zajíček's avatar
Ondřej Zajíček committed
25
	o  Routing Information Protocol (RIPv2, RIPng)
Pavel Tvrdik's avatar
Pavel Tvrdik committed
26
	o  Open Shortest Path First protocol (OSPFv2, OSPFv3)
Ondřej Zajíček's avatar
Ondřej Zajíček committed
27
	o  Babel Routing Protocol (Babel)
Pavel Tvrdik's avatar
Pavel Tvrdik committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
	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)
Ondřej Zajíček's avatar
Ondřej Zajíček committed
46 47 48
	o  From official binary packages for Debian and Red Hat Linux
	   ftp://bird.network.cz/pub/bird/debian/
	   ftp://bird.network.cz/pub/bird/redhat/
Pavel Tvrdik's avatar
Pavel Tvrdik committed
49 50
	o  From source code of the latest stable release version
	   ftp://bird.network.cz/pub/bird/
51
	o  From current development code in Git repository
Ondřej Zajíček's avatar
Ondřej Zajíček committed
52
	   https://gitlab.labs.nic.cz/labs/bird/
Pavel Tvrdik's avatar
Pavel Tvrdik committed
53

54
See the file INSTALL for information about installation from source code.
55

Pavel Tvrdik's avatar
Pavel Tvrdik committed
56 57 58 59 60 61
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
62
on your machine. You can also download a neatly formatted PDF version as
Pavel Tvrdik's avatar
Pavel Tvrdik committed
63 64 65 66
a separate archive (bird-doc-*.tar.gz) from ftp://bird.network.cz/pub/bird/

User support
============
67

Pavel Tvrdik's avatar
Pavel Tvrdik committed
68
If you want to help us debugging, enhancing and porting BIRD or just lurk
Ondřej Zajíček's avatar
Ondřej Zajíček committed
69 70 71 72 73 74 75
around to see what's going to develop, feel free to subscribe to the BIRD
users mailing list bird-users@network.cz, just send `subscribe' to
bird-request@network.cz. Bug reports, suggestions, feature requests and
code are welcome! We don't use gitlab issues for reporting, sorry.

Subscribe:	http://bird.network.cz/mailman/listinfo/bird-users/
Archive:	http://bird.network.cz/pipermail/bird-users/
76

Pavel Tvrdik's avatar
Pavel Tvrdik committed
77 78
Licence
=======
79

Pavel Tvrdik's avatar
Pavel Tvrdik committed
80 81 82 83
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.
84

Pavel Tvrdik's avatar
Pavel Tvrdik committed
85 86 87 88
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.
89

Pavel Tvrdik's avatar
Pavel Tvrdik committed
90 91 92
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
93

Pavel Tvrdik's avatar
Pavel Tvrdik committed
94 95
History
=======
96

Pavel Tvrdik's avatar
Pavel Tvrdik committed
97 98 99 100
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.
101

102

103 104
Good Luck and enjoy the BIRD :)
						The BIRD Team