| 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 | |
| 16 | To build in a terminal, change directory to the ndn_repo root. Enter: |
| 17 | |
| 18 | ./waf configure |
| 19 | ./waf |
| 20 | sudo ./waf install |
| 21 | |
| 22 | This makes and installs the following items: |
| 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 | |
| 27 | Config |
| 28 | ------ |
| 29 | |
| 30 | The default path of the configuration file is in `/usr/local/etc/ndn/repo-ng.conf`. |
| 31 | |
| 32 | The config file sample is repo-ng.conf.sample. Users should copy this file to the specific path and rename it to repo-ng.conf. |
| 33 | |
| 34 | Database |
| 35 | -------- |
| 36 | |
| 37 | Users do not need to manually generate a database for repo since when a repo is running, it will generate a database by itself. |
| 38 | |
| 39 | The default database path is `/var/db/ndn-repo-ng`, which can be changed in repo-ng.conf "storage.path". |
| 40 | |
| 41 | If the default database path is used, user should use root permission when running a repo. |
| 42 | |
| 43 | Tools |
| 44 | ----- |
| 45 | |
| 46 | Currently, three tools are supported : ndnputfile, ndngetfile and ndnrepowatch. |
| 47 | |
| 48 | Users can find the detail information about these tool in http://redmine.named-data.net/projects/repo-ng/wiki/Tools. |
| 49 | |