| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame^] | 1 | NLSR - Named Data Link State Routing Protocol |
| 2 | ============================================= |
| 3 | |
| 4 | NLSR is a routing protocol in NDN that populates NDN’s Forwarding Information Base. NLSR |
| 5 | will continue to evolve alongside the Named Data Networking `protocol`_. |
| 6 | |
| 7 | NLSR is an open and free software package licensed under the GPL 3.0 license and free to |
| 8 | all Internet users and developers. For more information about the licensing details and |
| 9 | limitations, refer to `COPYING.md`_. |
| 10 | |
| 11 | NLSR is developed by the members of the `NSF-sponsored NDN project team`_. For more |
| 12 | details, please refer to `AUTHORS.md`_. Bug reports and feedback are highly appreciated |
| 13 | and can be made through the `Redmine site`_. |
| 14 | |
| 15 | The main design goal of NLSR is to provide a routing protocol to populate NDN’s FIB. NLSR |
| 16 | calculates the routing table using link-state or hyperbolic routing and produces multiple |
| 17 | faces for each reachable name prefix in a single authoritative domain. NLSR will continue |
| 18 | to evolve over time to include neighbor discovery and to become a full fledged |
| 19 | inter-domain routing protocol for NDN. The project design is presented in full detail |
| 20 | in the `NLSR Paper`_. |
| 21 | |
| 22 | NLSR Documentation |
| 23 | ------------------- |
| 24 | |
| 25 | .. toctree:: |
| 26 | :hidden: |
| 27 | :maxdepth: 3 |
| 28 | |
| 29 | RELEASE-NOTES |
| 30 | INSTALL |
| 31 | GETTING-STARTED |
| 32 | ROUTER-CONFIG |
| 33 | SECURITY-CONFIG |
| 34 | |
| 35 | - :doc:`INSTALL` |
| 36 | - :doc:`GETTING-STARTED` |
| 37 | - :doc:`ROUTER-CONFIG` |
| 38 | - :doc:`SECURITY-CONFIG` |
| 39 | - :doc:`RELEASE-NOTES` |
| 40 | |
| 41 | Downloading |
| 42 | --------------- |
| 43 | |
| 44 | - `Github NLSR repository`_ |
| 45 | |
| 46 | Additional information |
| 47 | ---------------------- |
| 48 | |
| 49 | - `NLSR Wiki`_ |
| 50 | |
| 51 | .. _protocol: http://named-data.net/doc/ndn-tlv/ |
| 52 | |
| 53 | .. _Github NLSR repository: https://github.com/named-data/NLSR |
| 54 | |
| 55 | .. _NLSR Wiki: http://redmine.named-data.net/projects/nlsr/wiki/ |
| 56 | |
| 57 | .. _COPYING.md: https://github.com/named-data/NLSR/blob/master/COPYING.md |
| 58 | .. _NSF-sponsored NDN project team: http://named-data.net/project/participants/ |
| 59 | .. _AUTHORS.md: https://github.com/named-data/NLSR/blob/master/AUTHORS.md |
| 60 | .. _Redmine site: http://redmine.named-data.net/projects/nlsr |
| 61 | |
| 62 | .. _NLSR Paper: http://conferences.sigcomm.org/sigcomm/2013/papers/icn/p15.pdf |