Statistics
| Branch: | Revision:

iof-bird-daemon / README @ 678c97f2

History | View | Annotate | Download (4.31 KB)

1 9b3d2464 Pavel Tvrdik
                       BIRD Internet Routing Daemon
2 d8033f22 Martin Mares
3 9b3d2464 Pavel Tvrdik
                     Home page  http://bird.network.cz/
4
                  Mailing list  bird-users@network.cz
5 0ea2afe6 Pavel Tvrdik
6 9b3d2464 Pavel Tvrdik
                (c) 1998--2008  Martin Mares <mj@ucw.cz>
7 d8033f22 Martin Mares
                (c) 1998--2000  Pavel Machek <pavel@ucw.cz>
8 c94d56cb Martin Mares
                (c) 1998--2008  Ondrej Filip <feela@network.cz>
9 9b3d2464 Pavel Tvrdik
                (c) 2009--2016  CZ.NIC z.s.p.o.
10 d8033f22 Martin Mares
11
================================================================================
12
13 9b3d2464 Pavel Tvrdik
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 d8033f22 Martin Mares
19 9b3d2464 Pavel Tvrdik
What do we support
20
==================
21 67edcf39 Martin Mares
22 9b3d2464 Pavel Tvrdik
	o  Both IPv4 and IPv6 (use --enable-ipv6 when configuring)
23
	o  Multiple routing tables
24
	o  Border Gateway Protocol (BGPv4)
25 678c97f2 Ondrej Zajicek (work)
	o  Routing Information Protocol (RIPv2, RIPng)
26 9b3d2464 Pavel Tvrdik
	o  Open Shortest Path First protocol (OSPFv2, OSPFv3)
27 678c97f2 Ondrej Zajicek (work)
	o  Babel Routing Protocol (Babel)
28 9b3d2464 Pavel Tvrdik
	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 678c97f2 Ondrej Zajicek (work)
	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 9b3d2464 Pavel Tvrdik
	o  From source code of the latest stable release version
50
	   ftp://bird.network.cz/pub/bird/
51
	o  From source code of the actual development version
52 678c97f2 Ondrej Zajicek (work)
	   git://git.nic.cz/bird.git
53
	   https://gitlab.labs.nic.cz/labs/bird/
54 9b3d2464 Pavel Tvrdik
55 dbac8793 Pavel Tvrdik
How to install BIRD from source code
56 9b3d2464 Pavel Tvrdik
------------------------------------
57 678c97f2 Ondrej Zajicek (work)
58 9b3d2464 Pavel Tvrdik
	$  ./configure
59
	$  make
60 678c97f2 Ondrej Zajicek (work)
	$  su
61
	#  make install
62
	#  vi /usr/local/etc/bird.conf
63 9b3d2464 Pavel Tvrdik
64 678c97f2 Ondrej Zajicek (work)
See the file INSTALL for more information about installation from source code.
65 dbac8793 Pavel Tvrdik
66 9b3d2464 Pavel Tvrdik
Documentation
67
=============
68
69
Online documentation is available at http://bird.network.cz/?get_doc or as HTML
70
files in the doc directory, you can install it by `make install-docs' and
71
rebuild it by `make docs', but you'll need SGMLtools and LaTeX to be installed
72
on your machine. You can also download a neatly formatted PostScript version as
73
a separate archive (bird-doc-*.tar.gz) from ftp://bird.network.cz/pub/bird/
74
75
User support
76
============
77 d8033f22 Martin Mares
78 9b3d2464 Pavel Tvrdik
If you want to help us debugging, enhancing and porting BIRD or just lurk
79 678c97f2 Ondrej Zajicek (work)
around to see what's going to develop, feel free to subscribe to the BIRD
80
users mailing list bird-users@network.cz, just send `subscribe' to
81
bird-request@network.cz. Bug reports, suggestions, feature requests and
82
code are welcome! We don't use gitlab issues for reporting, sorry.
83
84
Subscribe:	http://bird.network.cz/mailman/listinfo/bird-users/
85
Archive:	http://bird.network.cz/pipermail/bird-users/
86 d8033f22 Martin Mares
87 9b3d2464 Pavel Tvrdik
Licence
88
=======
89 d8033f22 Martin Mares
90 9b3d2464 Pavel Tvrdik
This program is free software; you can redistribute it and/or modify
91
it under the terms of the GNU General Public License as published by
92
the Free Software Foundation; either version 2 of the License, or
93
(at your option) any later version.
94 d8033f22 Martin Mares
95 9b3d2464 Pavel Tvrdik
This program is distributed in the hope that it will be useful,
96
but WITHOUT ANY WARRANTY; without even the implied warranty of
97
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
98
GNU General Public License for more details.
99 d8033f22 Martin Mares
100 9b3d2464 Pavel Tvrdik
You should have received a copy of the GNU General Public License
101
along with this program; if not, write to the Free Software
102
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
103 d8033f22 Martin Mares
104 9b3d2464 Pavel Tvrdik
History
105
=======
106 89e7de98 Martin Mares
107 9b3d2464 Pavel Tvrdik
BIRD development started as a student project at the Faculty of Math
108
and Physics, Charles University, Prague, Czech Republic under supervision
109
of RNDr. Libor Forst <forst@cuni.cz>. BIRD has been developed and supported
110
by CZ.NIC z.s.p.o. http://www.nic.cz/ since 2009.
111 d8033f22 Martin Mares
112 1aa2a9c8 Martin Mares
113 d8033f22 Martin Mares
Good Luck and enjoy the BIRD :)
114
						The BIRD Team