]> git.proxmox.com Git - mirror_frr.git/blame_incremental - README.md
Merge pull request #8396 from achernavin22/ospf_fast_hello_show_run
[mirror_frr.git] / README.md
... / ...
CommitLineData
1<p align="center">
2<img src="http://docs.frrouting.org/en/latest/_static/frr-icon.svg" alt="Icon" width="20%"/>
3</p>
4
5FRRouting
6=========
7
8FRR is free software that implements and manages various IPv4 and IPv6 routing
9protocols. It runs on nearly all distributions of Linux and BSD and
10supports all modern CPU architectures.
11
12FRR currently supports the following protocols:
13
14* BGP
15* OSPFv2
16* OSPFv3
17* RIPv1
18* RIPv2
19* RIPng
20* IS-IS
21* PIM-SM/MSDP
22* LDP
23* BFD
24* Babel
25* PBR
26* OpenFabric
27* VRRP
28* EIGRP (alpha)
29* NHRP (alpha)
30
31Installation & Use
32------------------
33
34For source tarballs, see the
35[releases page](https://github.com/FRRouting/frr/releases).
36
37For Debian and its derivatives, use the APT repository at
38[https://deb.frrouting.org/](https://deb.frrouting.org/).
39
40Instructions on building and installing from source for supported platforms may
41be found in the
42[developer docs](http://docs.frrouting.org/projects/dev-guide/en/latest/building.html).
43
44Once installed, please refer to the [user guide](http://docs.frrouting.org/)
45for instructions on use.
46
47Community
48---------
49
50The FRRouting email list server is located
51[here](https://lists.frrouting.org/listinfo) and offers the following public
52lists:
53
54| Topic | List |
55|-------------------|------------------------------|
56| Development | dev@lists.frrouting.org |
57| Users & Operators | frog@lists.frrouting.org |
58| Announcements | announce@lists.frrouting.org |
59
60For chat, we currently use [Slack](https://frrouting.slack.com). You can join
61by clicking the "Slack" link under the
62[Participate](https://frrouting.org/#participate) section of our website.
63
64
65Contributing
66------------
67
68FRR maintains [developer's documentation](http://docs.frrouting.org/projects/dev-guide/en/latest/index.html)
69which contains the [project workflow](http://docs.frrouting.org/projects/dev-guide/en/latest/workflow.html)
70and expectations for contributors. Some technical documentation on project
71internals is also available.
72
73We welcome and appreciate all contributions, no matter how small!
74
75
76Security
77--------
78
79To report security issues, please use our security mailing list:
80
81```
82security [at] lists.frrouting.org
83```