| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 1 | # Installing repo-ng |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 2 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 3 | ## Prerequisites |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 4 | |
| Davide Pesavento | e9b09b8 | 2023-01-19 13:30:07 -0500 | [diff] [blame^] | 5 | * [ndn-cxx and its dependencies](https://docs.named-data.net/ndn-cxx/current/INSTALL.html) |
| Shuo Chen | 478204c | 2014-03-18 18:27:04 -0700 | [diff] [blame] | 6 | * sqlite3 |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 7 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 8 | ## Build |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 9 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 10 | To build in a terminal, change to the directory containing the repo-ng repository. |
| 11 | Then enter: |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 12 | |
| 13 | ./waf configure |
| 14 | ./waf |
| 15 | sudo ./waf install |
| 16 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame] | 17 | This builds and installs `ndn-repo-ng` and related tools. |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 18 | |
| Davide Pesavento | e9b09b8 | 2023-01-19 13:30:07 -0500 | [diff] [blame^] | 19 | If configured with tests (`./waf configure --with-tests`), the above commands |
| 20 | will also generate unit tests that can be run with `./build/unit-tests`. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 21 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 22 | ## Configuration |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 23 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame] | 24 | The default configuration file path is `/usr/local/etc/ndn/repo-ng.conf`. |
| Davide Pesavento | e9b09b8 | 2023-01-19 13:30:07 -0500 | [diff] [blame^] | 25 | Users may copy the [`repo-ng.conf.sample`](repo-ng.conf.sample) example config |
| 26 | to that path. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 27 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 28 | ## Database |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 29 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 30 | The database path is set in the `storage.path` key of the configuration file. |
| Davide Pesavento | 4162cc5 | 2019-01-25 01:32:30 -0500 | [diff] [blame] | 31 | The default database path is `/var/lib/ndn/repo-ng`. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 32 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 33 | repo-ng will automatically create a database if one does not exist. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 34 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 35 | Users should make sure that the `ndn-repo-ng` process has write access to the |
| 36 | database directory. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 37 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 38 | ## Tools |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 39 | |
| Davide Pesavento | e9b09b8 | 2023-01-19 13:30:07 -0500 | [diff] [blame^] | 40 | Currently, three tools are included: `ndngetfile`, `ndnputfile`, and `repo-ng-ls`. |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 41 | Users can find detailed information about these tools on the |
| 42 | [repo-ng wiki](https://redmine.named-data.net/projects/repo-ng/wiki/Tools). |