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