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