| Shuo Chen | 478204c | 2014-03-18 18:27:04 -0700 | [diff] [blame] | 1 | ndn-repo-ng: Next generation of NDN repository |
| 2 | =============================================== |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 3 | |
| 4 | Prerequisites |
| 5 | ------------- |
| 6 | |
| Shuo Chen | 478204c | 2014-03-18 18:27:04 -0700 | [diff] [blame] | 7 | Required: |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 8 | |
| Alexander Afanasyev | e291caf | 2014-04-25 11:17:36 -0700 | [diff] [blame] | 9 | * [ndn-cxx and its dependencies](https://github.com/named-data/ndn-cxx) |
| Shuo Chen | 478204c | 2014-03-18 18:27:04 -0700 | [diff] [blame] | 10 | * sqlite3 |
| 11 | * Boost libraries |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 12 | |
| 13 | Build |
| 14 | ----- |
| 15 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 16 | To build in a terminal, change directory to repo-ng repository. Enter: |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 17 | |
| 18 | ./waf configure |
| 19 | ./waf |
| 20 | sudo ./waf install |
| 21 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 22 | This builds and installs `ndn-repo-ng` and related tools. |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 23 | |
| Shuo Chen | 478204c | 2014-03-18 18:27:04 -0700 | [diff] [blame] | 24 | If configured with tests: `./waf configure --with-tests`), the above commands will |
| 25 | also generate unit tests in `./built/unit-tests` |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 26 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 27 | Configuration |
| 28 | ------------- |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 29 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 30 | The default configuration file path is `/usr/local/etc/ndn/repo-ng.conf`. |
| 31 | Users may copy `repo-ng.conf.sample` config sample to the specific path. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 32 | |
| 33 | Database |
| 34 | -------- |
| 35 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 36 | The database path is set in "storage.path" key of the config file. |
| 37 | The default database path is `/var/db/ndn-repo-ng`. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 38 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 39 | `ndn-repo-ng` automatically creates a database if one does not exist. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 40 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 41 | Users should make sure the `ndn-repo-ng` process has write privilege to the database path. |
| 42 | If the default `/var/db/ndn-repo-ng` is used, repo-ng needs to be started with `sudo`. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 43 | |
| 44 | Tools |
| 45 | ----- |
| 46 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 47 | Currently, three tools are supported: ndnputfile, ndngetfile, and ndnrepowatch. |
| Weiqi Shi | bd469da | 2014-08-21 10:08:51 -0700 | [diff] [blame] | 48 | |
| Junxiao Shi | 434fa49 | 2017-06-15 00:37:54 +0000 | [diff] [blame^] | 49 | Users can find detailed information about these tools in <https://redmine.named-data.net/projects/repo-ng/wiki/Tools>. |