]> git.ipfire.org Git - thirdparty/bird.git/blame_incremental - README
Merge branch 'add-path'
[thirdparty/bird.git] / README
... / ...
CommitLineData
1 BIRD Internet Routing Daemon
2
3 (c) 1998--2008 Martin Mares <mj@ucw.cz>
4 (c) 1998--2000 Pavel Machek <pavel@ucw.cz>
5 (c) 1998--2008 Ondrej Filip <feela@network.cz>
6 (c) 2009--2013 CZ.NIC z.s.p.o.
7
8================================================================================
9
10The BIRD project is an attempt to create a routing daemon running on UNIX-like
11systems (but not necessarily limited to them) with full support of all modern
12routing protocols, easy to use configuration interface and powerful route
13filtering language.
14
15If you want to help us debugging, enhancing and porting BIRD or just lurk
16around to see what's going to develop from this strange creature, feel free
17to subscribe to the BIRD users mailing list (bird-users@bird.network.cz),
18send subscribes to majordomo at the same machine). Bug reports, suggestions,
19feature requests (: and code :) are welcome.
20
21You can download the latest version from ftp://bird.network.cz/pub/bird/
22and look at the BIRD home page at http://bird.network.cz/.
23
24BIRD development started as a student project at the Faculty of Math
25and Physics, Charles University, Prague, Czech Republic under supervision
26of RNDr. Libor Forst <forst@cuni.cz>. BIRD has been developed and supported
27by CZ.NIC z.s.p.o. http://www.nic.cz/ since 2009.
28
29 This program is free software; you can redistribute it and/or modify
30 it under the terms of the GNU General Public License as published by
31 the Free Software Foundation; either version 2 of the License, or
32 (at your option) any later version.
33
34 This program is distributed in the hope that it will be useful,
35 but WITHOUT ANY WARRANTY; without even the implied warranty of
36 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 GNU General Public License for more details.
38
39 You should have received a copy of the GNU General Public License
40 along with this program; if not, write to the Free Software
41 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
42
43
44How to install BIRD:
45
46 ./configure
47 make
48 make install
49 vi /usr/local/etc/bird.conf
50
51Online documentation is available as HTML files in the doc directory,
52you can install it by `make install-docs' and rebuild it by `make docs',
53but for the latter you need SGMLtools and LaTeX to be installed on your
54machine. You can also download a neatly formatted PostScript version
55as a separate archive (bird-doc-*.tar.gz).
56
57What do we support:
58
59 o Both IPv4 and IPv6 (use --enable-ipv6 when configuring)
60 o Multiple routing tables
61 o BGP
62 o RIP
63 o OSPF
64 o Static routes
65 o Inter-table protocol
66 o IPv6 router advertisements
67 o Command-line interface (using the `birdc' client; to get
68 some help, just press `?')
69 o Soft reconfiguration -- no online commands for changing the
70 configuration in very limited ways, just edit the configuration
71 file and issue a `configure' command or send SIGHUP and BIRD
72 will start using the new configuration, possibly restarting
73 protocols affected by the configuration changes.
74 o Powerful language for route filtering (see doc/bird.conf.example).
75
76What is missing:
77
78 o See the TODO list
79
80Good Luck and enjoy the BIRD :)
81 The BIRD Team