| 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 | f6be8e3 | 2020-04-30 16:06:03 -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 | |
| Alexander Afanasyev | 67758b1 | 2018-03-06 18:36:44 -0500 | [diff] [blame] | 12 | Refer to `Getting started with NFD <https://named-data.net/doc/NFD/current/INSTALL.html>`_ |
| Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 13 | for detailed installation and running instruction. |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 14 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 15 | - PSync library |
| Ashlesh Gawande | 415676b | 2016-12-22 00:26:23 -0600 | [diff] [blame] | 16 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -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 | |
| Ashlesh Gawande | 30d96e4 | 2021-03-21 19:15:33 -0700 | [diff] [blame^] | 20 | - [Optional] ChronoSync library |
| 21 | |
| 22 | For testing purposes, NLSR can be optionally built with Chronosync support. |
| 23 | Download the ChronoSync library and build it according to the instructions available at |
| 24 | https://github.com/named-data/ChronoSync#build |
| 25 | |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 26 | Build |
| 27 | ----- |
| 28 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 29 | Execute the following commands to build NLSR:: |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 30 | |
| 31 | ./waf configure |
| 32 | ./waf |
| 33 | sudo ./waf install |
| 34 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 35 | 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] | 36 | how to properly configure NLSR. |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 37 | |
| Vince Lehman | 59dfac3 | 2015-04-29 12:37:26 -0500 | [diff] [blame] | 38 | If your pkgconfig path is not set properly you can do the following before running ``./waf |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 39 | configure``:: |
| Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 40 | |
| Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 41 | export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig |
| 42 | # or |
| Vince Lehman | 59dfac3 | 2015-04-29 12:37:26 -0500 | [diff] [blame] | 43 | export PKG_CONFIG_PATH=/path/to/pkgconfig/on/your/machine |
| Ashlesh Gawande | 30d96e4 | 2021-03-21 19:15:33 -0700 | [diff] [blame^] | 44 | |
| 45 | If ChronoSync support is desired, NLSR needs to be configured with the following option: |
| 46 | |
| 47 | ./waf configure --with-chronosync |