projects / mirror_frr.git / blame
| Commit | Line | Data |
|---|---|---|
| f20aafee QY |
1 | FRRouting |
| 2 | ========= | |
| 3 | ||
| 4 | FRR is free software that implements and manages various IPv4 and IPv6 routing | |
| 5 | protocols. It runs on nearly all distributions of Linux and BSD as well as | |
| 6 | Solaris and supports all modern CPU architectures. | |
| 7 | ||
| 8 | FRR currently supports the following protocols: | |
| 9 | ||
| 10 | * BGP | |
| 11 | * OSPFv2 | |
| 12 | * OSPFv3 | |
| 13 | * RIPv1 | |
| 14 | * RIPv2 | |
| 15 | * RIPng | |
| 16 | * IS-IS | |
| 17 | * PIM-SM/MSDP | |
| 18 | * LDP | |
| 19 | * BFD | |
| 20 | * Babel | |
| 21 | * EIGRP (alpha) | |
| 22 | * NHRP (alpha) | |
| 23 | ||
| 24 | Installation & Use | |
| 25 | ------------------ | |
| 26 | ||
| 27 | Packages are available for various distributions on our | |
| 28 | [releases page](https://github.com/FRRouting/frr/releases). | |
| 29 | ||
| 30 | Snaps are also available [here](https://snapcraft.io/frr). | |
| 31 | ||
| 32 | Instructions on building and installing from source for supported platforms may | |
| 33 | be found | |
| 34 | [here](http://docs.frrouting.org/projects/dev-guide/en/latest/building.html). | |
| 35 | ||
| 36 | Once installed, please refer to the [user guide](http://docs.frrouting.org/) | |
| 37 | for instructions on use. | |
| 38 | ||
| 39 | Community | |
| 40 | --------- | |
| 41 | ||
| 42 | The FRRouting email list server is located | |
| 43 | [here](https://lists.frrouting.org/listinfo) and offers the following public | |
| 44 | lists: | |
| 45 | ||
| 46 | | Topic | List | | |
| 47 | |-------------------|------------------------------| | |
| 48 | | Development | dev@lists.frrouting.org | | |
| 49 | | Users & Operators | frog@lists.frrouting.org | | |
| 50 | | Announcements | announce@lists.frrouting.org | | |
| 51 | ||
| 52 | For chat, we currently use [Slack](https://frrouting.slack.com). Please email | |
| 53 | the mailing list to request an invite as we do not issue automatic invites. | |
| 54 | ||
| 55 | ||
| 56 | Contributing | |
| 57 | ------------ | |
| 58 | ||
| 59 | FRR maintains [developer's documentation](http://docs.frrouting.org/projects/dev-guide/en/latest/index.html) | |
| 60 | which contains the [project workflow](http://docs.frrouting.org/projects/dev-guide/en/latest/workflow.html) | |
| 61 | and expectations for contributors. Some technical documentation on project | |
| 62 | internals is also available. | |
| 63 | ||
| 64 | We welcome and appreciate all contributions, no matter how small! | |
| 65 | ||
| 66 | ||
| 67 | Security | |
| 68 | -------- | |
| 69 | ||
| 70 | To report security issues, please use our security mailing list: | |
| 71 | ||
| 72 | ``` | |
| 73 | security [at] lists.frrouting.org | |
| 74 | ``` |