blob: 4dd6d1d9e71cfd9a2a3e9a228d67ea9a6be7b699 [file] [log] [blame]
Vince Lehmanb722b102014-08-24 16:33:49 -05001Getting Started with NLSR
2=========================
3
4.. toctree::
5..
6
7Getting Source
8--------------
9
10- `Github NLSR repository <https://github.com/named-data/NLSR>`_
11
12Installation
13------------
14
15:doc:`INSTALL`
16
17Configuration
18-------------
19
20After installing NLSR from source, you need to create a configuration file for
21NLSR. Please take a look at `nlsr.conf
22<https://github.com/named-data/NLSR/blob/master/nlsr.conf>`_ for a sample
23configuration. For details on configuring a router, please refer to
24:doc:`ROUTER-CONFIG`. For details on security configuration, please refer to
25:doc:`SECURITY-CONFIG`.
26
27Running
28-------
29
30Run nlsr with the following command:
31
32::
33
34 nlsr
35
36NLSR will look for the default configuration file, nlsr.conf, in the
37current directory.
38
39You can also run ``nlsr -f`` with the absolute path of
40the configuration file:
41
42::
43
44 nlsr -f /nlsr/nlsr.conf
45
46To run NLSR as daemon, use the -d flag:
47
48::
49
50 nlsr -d