README 4.31 KB
Newer Older
Pavel Tvrdik committed
1
                       BIRD Internet Routing Daemon
2

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

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>
Pavel Tvrdik committed
9
                (c) 2009--2016  CZ.NIC z.s.p.o.
10 11 12

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

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 committed
19 20
What do we support
==================
21

Pavel Tvrdik committed
22 23 24
	o  Both IPv4 and IPv6 (use --enable-ipv6 when configuring)
	o  Multiple routing tables
	o  Border Gateway Protocol (BGPv4)
Ondřej Zajíček committed
25
	o  Routing Information Protocol (RIPv2, RIPng)
Pavel Tvrdik committed
26
	o  Open Shortest Path First protocol (OSPFv2, OSPFv3)
Ondřej Zajíček committed
27
	o  Babel Routing Protocol (Babel)
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 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 committed
49 50 51
	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
Ondřej Zajíček committed
52 53
	   git://git.nic.cz/bird.git
	   https://gitlab.labs.nic.cz/labs/bird/
Pavel Tvrdik committed
54

55
How to install BIRD from source code
Pavel Tvrdik committed
56
------------------------------------
Ondřej Zajíček committed
57

Pavel Tvrdik committed
58 59
	$  ./configure
	$  make
Ondřej Zajíček committed
60 61 62
	$  su
	#  make install
	#  vi /usr/local/etc/bird.conf
Pavel Tvrdik committed
63

Ondřej Zajíček committed
64
See the file INSTALL for more information about installation from source code.
65

Pavel Tvrdik committed
66 67 68 69 70 71 72 73 74 75 76
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
============
77

Pavel Tvrdik committed
78
If you want to help us debugging, enhancing and porting BIRD or just lurk
Ondřej Zajíček committed
79 80 81 82 83 84 85
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/
86

Pavel Tvrdik committed
87 88
Licence
=======
89

Pavel Tvrdik committed
90 91 92 93
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.
94

Pavel Tvrdik committed
95 96 97 98
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.
99

Pavel Tvrdik committed
100 101 102
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
103

Pavel Tvrdik committed
104 105
History
=======
106

Pavel Tvrdik committed
107 108 109 110
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.
111

112

113 114
Good Luck and enjoy the BIRD :)
						The BIRD Team