Gitiles
Code Review Sign In
gerrit.named-data.net / NLSR / 2e6c8bb8963c4fbff0bc24ec11f12909414f7348 / . / docs / index.rst
blob: f13d470c81dcd7a55dc9041a3d14b046e9e892fd [file] [log] [blame]
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]1NLSR - Named Data Link State Routing Protocol
2=============================================
3
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]4NLSR is a routing protocol in NDN that populates NDN's Routing Information Base. NLSR will
5continue to evolve alongside the Named Data Networking `protocol
Ashlesh Gawande30096b82017-03-30 12:20:50 -0500[diff] [blame]6<https://named-data.net/doc/ndn-tlv/>`_.
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]7
8NLSR is an open and free software package licensed under the GPL 3.0 license and free to
9all Internet users and developers. For more information about the licensing details and
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]10limitations, refer to `COPYING.md
11<https://github.com/named-data/NLSR/blob/master/COPYING.md>`_.
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]12
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]13NLSR is developed by the members of the `NSF-sponsored NDN project team
Ashlesh Gawande30096b82017-03-30 12:20:50 -0500[diff] [blame]14<https://named-data.net/project/participants/>`_. For more details, please refer to
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]15`AUTHORS.md <https://github.com/named-data/NLSR/blob/master/AUTHORS.md>`_. Bug reports and
16feedback are highly appreciated and can be made through the `NLSR Wiki`_.
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]17
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]18The main design goal of NLSR is to provide a routing protocol to populate NDN's FIB. NLSR
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]19calculates the routing table using link-state or hyperbolic routing and produces multiple
20faces for each reachable name prefix in a single authoritative domain. NLSR will continue
21to evolve over time to include neighbor discovery and to become a full fledged
Junxiao Shif09e2632015-01-02 18:15:01 -0700[diff] [blame]22inter-domain routing protocol for NDN. The protocol design is presented in full detail in
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]23the `NLSR Paper`_.
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]24
25NLSR Documentation
26-------------------
27
28.. toctree::
29 :hidden:
30 :maxdepth: 3
31
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]32 GETTING-STARTED
Vince Lehman18df0602015-05-01 11:24:10 -0500[diff] [blame]33 INSTALL
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]34 ROUTER-CONFIG
35 SECURITY-CONFIG
Ashlesh Gawande9e955bc2017-11-30 17:33:03 -0600[diff] [blame]36 RELEASE-NOTES
37 releases
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]38 manpages
David Arjona2e6c8bb2018-11-14 16:27:09 -0600[diff] [blame^]39 beginners-guide
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]40
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]41- :doc:`GETTING-STARTED`
Vince Lehman18df0602015-05-01 11:24:10 -0500[diff] [blame]42- :doc:`INSTALL`
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]43- :doc:`ROUTER-CONFIG`
44- :doc:`SECURITY-CONFIG`
45- :doc:`RELEASE-NOTES`
Ashlesh Gawande9e955bc2017-11-30 17:33:03 -0600[diff] [blame]46- :doc:`releases`
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]47- :doc:`manpages`
David Arjona2e6c8bb2018-11-14 16:27:09 -0600[diff] [blame^]48- :doc:`beginners-guide`
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]49
50Downloading
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]51-----------
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]52
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]53- `GitHub NLSR repository <https://github.com/named-data/NLSR>`_
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]54
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]55NLSR mailing list
56-----------------
57
58- `NLSR Mailing List`_
59
60- `NLSR Mailing List Archives`_
61
62`Sign up`_ is needed to post to the list or access the archives.
63
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]64Additional information
65----------------------
66
67- `NLSR Wiki`_
68
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]69- `NLSR Redmine`_
70 Feature requests and bug reports
71
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]72- `NLSR Paper`_
73 Detailed explanation of the NLSR design
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]74
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]75- `NLSR Developer's Guide`_
76 For NLSR Development
Vince Lehmanb722b102014-08-24 16:33:49 -0500[diff] [blame]77
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]78.. _NLSR Wiki: https://redmine.named-data.net/projects/nlsr/wiki
Ashlesh Gawande30096b82017-03-30 12:20:50 -0500[diff] [blame]79.. _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]80.. _NLSR Mailing List: https://listserv.memphis.edu/scripts/wa.exe?SUBED1=NLSR-HELP-L&A=1
81.. _NLSR Mailing List Archives: https://listserv.memphis.edu/scripts/wa.exe?A0=NLSR-HELP-L
82.. _NLSR Developer's Guide: https://github.com/named-data/NLSR/blob/developers-guide/NLSR-Developers-Guide.pdf
83.. _Sign up: https://listserv.memphis.edu/scripts/wa.exe?GETPW1
84.. _NLSR Redmine: https://redmine.named-data.net/projects/nlsr