README.md

   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 * PBR
  22 * OpenFabric
  23 * VRRP
  24 * EIGRP (alpha)
  25 * NHRP (alpha)
  26
  27 Installation & Use
  28 ------------------
  29
  30 For source tarballs, see the
  31 [releases page](https://github.com/FRRouting/frr/releases).
  32
  33 For Debian and its derivatives, use the APT repository at
  34 [https://deb.frrouting.org/](https://deb.frrouting.org/).
  35
  36 Instructions on building and installing from source for supported platforms may
  37 be found in the
  38 [developer docs](http://docs.frrouting.org/projects/dev-guide/en/latest/building.html).
  39
  40 Once installed, please refer to the [user guide](http://docs.frrouting.org/)
  41 for instructions on use.
  42
  43 Community
  44 ---------
  45
  46 The FRRouting email list server is located
  47 [here](https://lists.frrouting.org/listinfo) and offers the following public
  48 lists:
  49
  50 | Topic             | List                         |
  51 |-------------------|------------------------------|
  52 | Development       | dev@lists.frrouting.org      |
  53 | Users & Operators | frog@lists.frrouting.org     |
  54 | Announcements     | announce@lists.frrouting.org |
  55
  56 For chat, we currently use [Slack](https://frrouting.slack.com). You can join
  57 by clicking the "Slack" link under the
  58 [Participate](https://frrouting.org/#participate) section of our website.
  59
  60
  61 Contributing
  62 ------------
  63
  64 FRR maintains [developer's documentation](http://docs.frrouting.org/projects/dev-guide/en/latest/index.html)
  65 which contains the [project workflow](http://docs.frrouting.org/projects/dev-guide/en/latest/workflow.html)
  66 and expectations for contributors. Some technical documentation on project
  67 internals is also available.
  68
  69 We welcome and appreciate all contributions, no matter how small!
  70
  71
  72 Security
  73 --------
  74
  75 To report security issues, please use our security mailing list:
  76
  77 ```
  78 security [at] lists.frrouting.org
  79 ```