| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 1 | # NLSR: Named Data Link State Routing Protocol |
| 2 | |
| Davide Pesavento | 5021314 | 2024-04-22 03:44:05 -0400 | [diff] [blame] | 3 |  |
| 4 |  |
| Davide Pesavento | ba8a4ed | 2021-10-13 21:28:43 -0400 | [diff] [blame] | 5 | [](https://github.com/named-data/NLSR/actions/workflows/ci.yml) |
| Davide Pesavento | c56457b | 2024-05-08 17:18:33 -0400 | [diff] [blame] | 6 | [](https://github.com/named-data/NLSR/actions/workflows/docker.yml) |
| Davide Pesavento | ba8a4ed | 2021-10-13 21:28:43 -0400 | [diff] [blame] | 7 | [](https://github.com/named-data/NLSR/actions/workflows/docs.yml) |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 8 | |
| Davide Pesavento | 5021314 | 2024-04-22 03:44:05 -0400 | [diff] [blame] | 9 | > [!TIP] |
| 10 | > For more extensive documentation, visit the [NLSR homepage](https://docs.named-data.net/NLSR/current/). |
| Junxiao Shi | f09e263 | 2015-01-02 18:15:01 -0700 | [diff] [blame] | 11 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 12 | ## Overview |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 13 | |
| Davide Pesavento | 1e9faf1 | 2023-01-21 16:04:50 -0500 | [diff] [blame] | 14 | NLSR is a routing protocol for Named Data Networking (NDN) that populates the Routing Information |
| 15 | Base (RIB) of an NDN router, such as [NFD](https://github.com/named-data/NFD). NLSR continues to |
| 16 | evolve alongside the core [NDN protocol](https://docs.named-data.net/NDN-packet-spec/current/). |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 17 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 18 | The main design goal of NLSR is to provide a routing protocol to populate NDN's RIB. |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 19 | NLSR calculates the routing table using link-state or hyperbolic routing and produces |
| 20 | multiple faces for each reachable name prefix in a single authoritative domain. NLSR |
| 21 | will continue to evolve over time to include neighbor discovery and to become a full |
| 22 | fledged inter-domain routing protocol for NDN. |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 23 | |
| Davide Pesavento | c56457b | 2024-05-08 17:18:33 -0400 | [diff] [blame] | 24 | NLSR was mainly developed by members of the NSF-sponsored [NDN project]( |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 25 | https://named-data.net/project/participants/). See [`AUTHORS.md`](AUTHORS.md) for details. |
| 26 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 27 | ## Source releases |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 28 | |
| Davide Pesavento | c1d0e8e | 2022-06-15 14:26:02 -0400 | [diff] [blame] | 29 | The source code and installation instructions are available at the following locations: |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 30 | |
| Davide Pesavento | 1e9faf1 | 2023-01-21 16:04:50 -0500 | [diff] [blame] | 31 | - [Installation](https://docs.named-data.net/NLSR/current/INSTALL.html) |
| 32 | - [Getting started with NLSR](https://docs.named-data.net/NLSR/current/GETTING-STARTED.html) |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 33 | - [NLSR GitHub repository](https://github.com/named-data/NLSR) |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 34 | |
| Davide Pesavento | 1e9faf1 | 2023-01-21 16:04:50 -0500 | [diff] [blame] | 35 | ## Reporting bugs |
| 36 | |
| 37 | Please submit any bug reports or feature requests to the |
| 38 | [NLSR issue tracker](https://redmine.named-data.net/projects/nlsr/issues). |
| 39 | |
| Davide Pesavento | c1d0e8e | 2022-06-15 14:26:02 -0400 | [diff] [blame] | 40 | ## Additional resources |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 41 | |
| Davide Pesavento | 1e9faf1 | 2023-01-21 16:04:50 -0500 | [diff] [blame] | 42 | - [Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md) |
| Davide Pesavento | c1d0e8e | 2022-06-15 14:26:02 -0400 | [diff] [blame] | 43 | - [NLSR Wiki](https://redmine.named-data.net/projects/nlsr/wiki) |
| 44 | - [NLSR Issue Tracker](https://redmine.named-data.net/projects/nlsr/issues) |
| Ashlesh Gawande | b4567f4 | 2017-04-28 14:40:39 -0500 | [diff] [blame] | 45 | - [NLSR Mailing List Sign Up](https://listserv.memphis.edu/scripts/wa.exe?GETPW1) |
| 46 | - [NLSR Mailing List](https://listserv.memphis.edu/scripts/wa.exe?SUBED1=NLSR-HELP-L&A=1) |
| 47 | - [NLSR Mailing List Archives](https://listserv.memphis.edu/scripts/wa.exe?A0=NLSR-HELP-L) |
| dmcoomes | a47255c | 2017-09-29 16:08:32 -0500 | [diff] [blame] | 48 | - [NLSR Developer's guide](https://github.com/named-data/NLSR/blob/developers-guide/NLSR-Developers-Guide.pdf) |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 49 | |
| 50 | ## License |
| 51 | |
| 52 | NLSR is free software distributed under the GNU General Public License version 3. |
| 53 | See [`COPYING.md`](COPYING.md) for details. |
| Davide Pesavento | 5021314 | 2024-04-22 03:44:05 -0400 | [diff] [blame] | 54 | |
| 55 | NLSR contains third-party software, licensed under the following licenses: |
| 56 | |
| 57 | - The *waf* build system is licensed under the [3-clause BSD license](waf) |