Gitiles
Code Review Sign In
gerrit.named-data.net / NLSR / 1e9faf1d1bb4437b783f2ed3df9f0391ff5abc3e / . / docs / index.rst
blob: 626006e88c2bd7fb0381d02f7ed374e8e6d5df1b [file] [log] [blame]
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]1NLSR: Named Data Link State Routing Protocol
2============================================
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]3
4.. toctree::
5 :hidden:
Davide Pesavento7ae8b082021-10-12 21:45:47 -0400[diff] [blame]6 :maxdepth: 2
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]7
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]8 GETTING-STARTED
Vince Lehman18df0602015-05-01 11:24:10 -0500[diff] [blame]9 INSTALL
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]10 SECURITY-CONFIG
David Arjona2fa23ea2018-11-28 11:50:38 -0600[diff] [blame]11 ROUTER-CONFIG
David Arjona2e6c8bb2018-11-14 16:27:09 -0600[diff] [blame]12 beginners-guide
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]13 manpages
14 release-notes
15 releases
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]16
Davide Pesavento1e9faf12023-01-21 16:04:50 -0500[diff] [blame^]17**NLSR** is a routing protocol for Named Data Networking (NDN) that populates the Routing
18Information Base (RIB) of an NDN router, such as `NFD`_. NLSR continues to evolve alongside
19the core `NDN protocol`_.
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]20
21The main design goal of NLSR is to provide a routing protocol to populate NDN's FIB. NLSR
22calculates the routing table using link-state or hyperbolic routing and produces multiple
23faces for each reachable name prefix in a single authoritative domain. NLSR will continue
24to evolve over time to include neighbor discovery and to become a full fledged
25inter-domain routing protocol for NDN. The protocol design is presented in full detail in
26the `NLSR Paper`_.
27
28NLSR was mainly developed by members of the NSF-sponsored `NDN project team
29<https://named-data.net/project/participants/>`__. See `AUTHORS.md
30<https://github.com/named-data/NLSR/blob/master/AUTHORS.md>`__ for details.
31
32Bug reports and feedback are highly appreciated and can be made through the `NLSR Redmine`_.
33
34Documentation
35-------------
36
37- :doc:`GETTING-STARTED`
38- :doc:`INSTALL`
39- :doc:`SECURITY-CONFIG`
40- :doc:`ROUTER-CONFIG`
41- :doc:`beginners-guide`
42- :doc:`manpages`
43- :doc:`release-notes`
44- :doc:`releases`
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]45
46Downloading
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]47-----------
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]48
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]49- `Source code git repository <https://github.com/named-data/NLSR>`__
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]50
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]51NLSR mailing list
52-----------------
53
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]54- `NLSR Mailing List`_
55- `NLSR Mailing List Archives`_
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]56
57`Sign up`_ is needed to post to the list or access the archives.
58
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]59Additional resources
60--------------------
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]61
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]62- `NLSR Wiki`_
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]63
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]64- `NLSR Redmine`_
65 Feature requests and bug reports
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]66
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]67- `NLSR Paper`_
68 Detailed explanation of NLSR's design
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]69
Davide Pesavento1b640fd2023-01-04 21:00:05 -0500[diff] [blame]70- `NLSR Developer's Guide`_
71 For NLSR development
72
73- `API documentation (doxygen) <doxygen/annotated.html>`__
74
75License
76-------
77
78NLSR is free software distributed under the GNU General Public License version 3.
79See `COPYING.md <https://github.com/named-data/NLSR/blob/master/COPYING.md>`__ for details.
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]80
Davide Pesavento1e9faf12023-01-21 16:04:50 -0500[diff] [blame^]81.. _NDN protocol: https://docs.named-data.net/NDN-packet-spec/current/
82.. _NFD: https://github.com/named-data/NFD
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]83.. _NLSR Wiki: https://redmine.named-data.net/projects/nlsr/wiki
Ashlesh Gawande30096b82017-03-30 12:20:50 -0500[diff] [blame]84.. _NLSR Paper: https://named-data.net/wp-content/uploads/2016/01/ndn-0037-1-nlsr.pdf
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]85.. _NLSR Mailing List: https://listserv.memphis.edu/scripts/wa.exe?SUBED1=NLSR-HELP-L&A=1
86.. _NLSR Mailing List Archives: https://listserv.memphis.edu/scripts/wa.exe?A0=NLSR-HELP-L
87.. _NLSR Developer's Guide: https://github.com/named-data/NLSR/blob/developers-guide/NLSR-Developers-Guide.pdf
88.. _Sign up: https://listserv.memphis.edu/scripts/wa.exe?GETPW1
89.. _NLSR Redmine: https://redmine.named-data.net/projects/nlsr