Davide Pesavento
1e9faf1d1b
Also fix a few outdated URLs in docs Change-Id: I4269ca53f55433568e8fd93eec497697c01b3c6d
52 lines
2.7 KiB
Markdown
52 lines
2.7 KiB
Markdown
# NLSR: Named Data Link State Routing Protocol
|
|
|
|
[](https://github.com/named-data/NLSR/actions/workflows/ci.yml)
|
|
[](https://github.com/named-data/NLSR/actions/workflows/docs.yml)
|
|
|
|
|
|
|
|
> For more extensive documentation, please visit the [NLSR homepage](https://docs.named-data.net/NLSR/current/).
|
|
|
|
## Overview
|
|
|
|
NLSR is a routing protocol for Named Data Networking (NDN) that populates the Routing Information
|
|
Base (RIB) of an NDN router, such as [NFD](https://github.com/named-data/NFD). NLSR continues to
|
|
evolve alongside the core [NDN protocol](https://docs.named-data.net/NDN-packet-spec/current/).
|
|
|
|
The main design goal of NLSR is to provide a routing protocol to populate NDN's RIB.
|
|
NLSR calculates the routing table using link-state or hyperbolic routing and produces
|
|
multiple faces for each reachable name prefix in a single authoritative domain. NLSR
|
|
will continue to evolve over time to include neighbor discovery and to become a full
|
|
fledged inter-domain routing protocol for NDN.
|
|
|
|
NLSR was mainly developed by members of the NSF-sponsored [NDN project team](
|
|
https://named-data.net/project/participants/). See [`AUTHORS.md`](AUTHORS.md) for details.
|
|
|
|
## Source releases
|
|
|
|
The source code and installation instructions are available at the following locations:
|
|
|
|
- [Installation](https://docs.named-data.net/NLSR/current/INSTALL.html)
|
|
- [Getting started with NLSR](https://docs.named-data.net/NLSR/current/GETTING-STARTED.html)
|
|
- [NLSR GitHub repository](https://github.com/named-data/NLSR)
|
|
|
|
## Reporting bugs
|
|
|
|
Please submit any bug reports or feature requests to the
|
|
[NLSR issue tracker](https://redmine.named-data.net/projects/nlsr/issues).
|
|
|
|
## Additional resources
|
|
|
|
- [Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md)
|
|
- [NLSR Wiki](https://redmine.named-data.net/projects/nlsr/wiki)
|
|
- [NLSR Issue Tracker](https://redmine.named-data.net/projects/nlsr/issues)
|
|
- [NLSR Mailing List Sign Up](https://listserv.memphis.edu/scripts/wa.exe?GETPW1)
|
|
- [NLSR Mailing List](https://listserv.memphis.edu/scripts/wa.exe?SUBED1=NLSR-HELP-L&A=1)
|
|
- [NLSR Mailing List Archives](https://listserv.memphis.edu/scripts/wa.exe?A0=NLSR-HELP-L)
|
|
- [NLSR Developer's guide](https://github.com/named-data/NLSR/blob/developers-guide/NLSR-Developers-Guide.pdf)
|
|
|
|
## License
|
|
|
|
NLSR is free software distributed under the GNU General Public License version 3.
|
|
See [`COPYING.md`](COPYING.md) for details.
|