projects / mirror_frr.git / blame
| Commit | Line | Data |
|---|---|---|
| e79a7550 SW |
1 | <p align="center"> |
| 2 | <img src="http://docs.frrouting.org/en/latest/_static/frr-icon.svg" alt="Icon" width="20%"/> | |
| 3 | </p> | |
| 4 | ||
| f20aafee QY |
5 | FRRouting |
| 6 | ========= | |
| 7 | ||
| 8 | FRR is free software that implements and manages various IPv4 and IPv6 routing | |
| 9 | protocols. It runs on nearly all distributions of Linux and BSD as well as | |
| 10 | Solaris and supports all modern CPU architectures. | |
| 11 | ||
| 12 | FRR 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 | |
| 4ceb90ec QY |
25 | * PBR |
| 26 | * OpenFabric | |
| ffd9ddf1 | 27 | * VRRP |
| f20aafee QY |
28 | * EIGRP (alpha) |
| 29 | * NHRP (alpha) | |
| 30 | ||
| 31 | Installation & Use | |
| 32 | ------------------ | |
| 33 | ||
| b6d1d2a0 | 34 | For source tarballs, see the |
| f20aafee QY |
35 | [releases page](https://github.com/FRRouting/frr/releases). |
| 36 | ||
| b6d1d2a0 QY |
37 | For Debian and its derivatives, use the APT repository at |
| 38 | [https://deb.frrouting.org/](https://deb.frrouting.org/). | |
| f20aafee QY |
39 | |
| 40 | Instructions on building and installing from source for supported platforms may | |
| b6d1d2a0 QY |
41 | be found in the |
| 42 | [developer docs](http://docs.frrouting.org/projects/dev-guide/en/latest/building.html). | |
| f20aafee QY |
43 | |
| 44 | Once installed, please refer to the [user guide](http://docs.frrouting.org/) | |
| 45 | for instructions on use. | |
| 46 | ||
| 47 | Community | |
| 48 | --------- | |
| 49 | ||
| 50 | The FRRouting email list server is located | |
| 51 | [here](https://lists.frrouting.org/listinfo) and offers the following public | |
| 52 | lists: | |
| 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 | ||
| 5fe863b2 QY |
60 | For chat, we currently use [Slack](https://frrouting.slack.com). You can join |
| 61 | by clicking the "Slack" link under the | |
| 62 | [Participate](https://frrouting.org/#participate) section of our website. | |
| f20aafee QY |
63 | |
| 64 | ||
| 65 | Contributing | |
| 66 | ------------ | |
| 67 | ||
| 68 | FRR maintains [developer's documentation](http://docs.frrouting.org/projects/dev-guide/en/latest/index.html) | |
| 69 | which contains the [project workflow](http://docs.frrouting.org/projects/dev-guide/en/latest/workflow.html) | |
| 70 | and expectations for contributors. Some technical documentation on project | |
| 71 | internals is also available. | |
| 72 | ||
| 73 | We welcome and appreciate all contributions, no matter how small! | |
| 74 | ||
| 75 | ||
| 76 | Security | |
| 77 | -------- | |
| 78 | ||
| 79 | To report security issues, please use our security mailing list: | |
| 80 | ||
| 81 | ``` | |
| 82 | security [at] lists.frrouting.org | |
| 83 | ``` |