Gitiles
Code Review Sign In
gerrit.named-data.net / repo-ng / cf9feb44c485e7f9c60808bb95a189cce92939db / . / INSTALL.md
blob: 08070d0443514a05d3b7552fe57014cb1d4c7a7b [file] [log] [blame] [view]
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]1# Installing repo-ng
Shuo Chen050fcad2014-03-12 15:45:54 -0700[diff] [blame]2
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]3## Prerequisites
Shuo Chen050fcad2014-03-12 15:45:54 -0700[diff] [blame]4
Davide Pesaventoe9b09b82023-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 Chen478204c2014-03-18 18:27:04 -0700[diff] [blame]6* sqlite3
Shuo Chen050fcad2014-03-12 15:45:54 -0700[diff] [blame]7
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]8## Build
Shuo Chen050fcad2014-03-12 15:45:54 -0700[diff] [blame]9
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]10To build in a terminal, change to the directory containing the repo-ng repository.
11Then enter:
Shuo Chen050fcad2014-03-12 15:45:54 -0700[diff] [blame]12
Davide Pesaventocf9feb42024-04-22 23:08:25 -0400[diff] [blame^]13```shell
14./waf configure
15./waf
16sudo ./waf install
17```
Shuo Chen050fcad2014-03-12 15:45:54 -0700[diff] [blame]18
Junxiao Shi434fa492017-06-15 00:37:54 +0000[diff] [blame]19This builds and installs `ndn-repo-ng` and related tools.
Shuo Chen050fcad2014-03-12 15:45:54 -0700[diff] [blame]20
Davide Pesaventoe9b09b82023-01-19 13:30:07 -0500[diff] [blame]21If configured with tests (`./waf configure --with-tests`), the above commands
22will also generate unit tests that can be run with `./build/unit-tests`.
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]23
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]24## Configuration
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]25
Junxiao Shi434fa492017-06-15 00:37:54 +0000[diff] [blame]26The default configuration file path is `/usr/local/etc/ndn/repo-ng.conf`.
Davide Pesaventoe9b09b82023-01-19 13:30:07 -0500[diff] [blame]27Users may copy the [`repo-ng.conf.sample`](repo-ng.conf.sample) example config
28to that path.
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]29
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]30## Database
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]31
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]32The database path is set in the `storage.path` key of the configuration file.
Davide Pesavento4162cc52019-01-25 01:32:30 -0500[diff] [blame]33The default database path is `/var/lib/ndn/repo-ng`.
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]34
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]35repo-ng will automatically create a database if one does not exist.
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]36
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]37Users should make sure that the `ndn-repo-ng` process has write access to the
38database directory.
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]39
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]40## Tools
Weiqi Shibd469da2014-08-21 10:08:51 -0700[diff] [blame]41
Davide Pesaventoe9b09b82023-01-19 13:30:07 -0500[diff] [blame]42Currently, three tools are included: `ndngetfile`, `ndnputfile`, and `repo-ng-ls`.
Davide Pesavento4a160042020-04-13 16:50:02 -0400[diff] [blame]43Users can find detailed information about these tools on the
44[repo-ng wiki](https://redmine.named-data.net/projects/repo-ng/wiki/Tools).