| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 1 | NLSR Installation Instructions |
| 2 | ============================== |
| 3 | |
| 4 | .. toctree:: |
| 5 | .. |
| 6 | |
| 7 | Prerequisites |
| 8 | ------------- |
| 9 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 10 | - `NFD <https://named-data.net/doc/NFD/>`_ and its dependencies |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 11 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 12 | Refer to `Getting started with NFD <https://named-data.net/doc/NFD/current/INSTALL.html>`_ |
| 13 | for detailed installation and running instruction. |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 14 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 15 | - PSync library |
| Ashlesh Gawande | 415676b | 2016-12-22 00:26:23 -0600 | [diff] [blame] | 16 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 17 | Download the PSync library and build it according to the instructions available at |
| 18 | https://github.com/named-data/PSync#build |
| Ashlesh Gawande | 32ec3fd | 2018-07-18 13:42:32 -0500 | [diff] [blame] | 19 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 20 | - [Optional] ChronoSync library |
| Ashlesh Gawande | 30d96e4 | 2021-03-21 19:15:33 -0700 | [diff] [blame] | 21 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 22 | For testing purposes, NLSR can be optionally built with Chronosync support. Download |
| 23 | the ChronoSync library and build it according to the instructions available at |
| 24 | https://github.com/named-data/ChronoSync#build |
| Ashlesh Gawande | 30d96e4 | 2021-03-21 19:15:33 -0700 | [diff] [blame] | 25 | |
| Varun Patil | 7d2d689 | 2022-10-14 12:50:30 -0700 | [diff] [blame^] | 26 | - [Optional] SVS library |
| 27 | |
| 28 | NLSR can be used with State Vector Sync as the underlying Sync protocol. Download |
| 29 | the ndn-svs library and build it according to the instructions available at |
| 30 | https://github.com/named-data/ndn-svs#installation |
| 31 | |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 32 | Build |
| 33 | ----- |
| 34 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 35 | Execute the following commands to build NLSR: |
| 36 | |
| 37 | .. code-block:: sh |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 38 | |
| 39 | ./waf configure |
| 40 | ./waf |
| 41 | sudo ./waf install |
| 42 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 43 | Refer to ``./waf --help`` for more options that can be used during the configure stage and |
| Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 44 | how to properly configure NLSR. |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 45 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 46 | If your pkgconfig path is not set properly, you can do the following before running ``./waf |
| 47 | configure``: |
| 48 | |
| 49 | .. code-block:: sh |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 50 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 51 | export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig |
| 52 | # or |
| Vince Lehman | 59dfac3 | 2015-04-29 12:37:26 -0500 | [diff] [blame] | 53 | export PKG_CONFIG_PATH=/path/to/pkgconfig/on/your/machine |
| Ashlesh Gawande | 30d96e4 | 2021-03-21 19:15:33 -0700 | [diff] [blame] | 54 | |
| 55 | If ChronoSync support is desired, NLSR needs to be configured with the following option: |
| 56 | |
| Davide Pesavento | ede5963 | 2022-08-26 20:35:44 -0400 | [diff] [blame] | 57 | .. code-block:: sh |
| 58 | |
| 59 | ./waf configure --with-chronosync |