Gitiles
Code Review Sign In
gerrit.named-data.net / ndnSIM / 60df7214317c011a424643c08c3c2ad8c51c2527
commit60df7214317c011a424643c08c3c2ad8c51c2527[log] [tgz]
authorObaid <soamin@memphis.edu>Fri Apr 11 18:04:37 2014 -0500
committerObaid <soamin@memphis.edu>Sun Apr 13 09:37:51 2014 -0500
tree015348f8a24eb29d32c1d3ca1614b5fe413624b9
parent5748c0c165ff333aea87deb29ab5108984e569b4 [diff]
docs: Added a readme for nrd.

refs #1463

Change-Id: I157d63b5768eda9e301527106e3f0bfd7af31f6f
1 file changed
tree: 015348f8a24eb29d32c1d3ca1614b5fe413624b9
  1. .waf-tools/
  2. src/
  3. tests/
  4. .gitignore
  5. INSTALL.md
  6. nrd.conf.sample
  7. README.md
  8. waf
  9. wscript
README.md

NRD (NDN Routing Daemon)

NRD works in parallel with NFD and provides services for prefix registration.

For installation details please see INSTALL.md.

Default Paths

This README uses SYSCONFDIR when referring to the default locations of various configuration files. By default, SYSCONFDIR is set to /usr/local/etc. If you override just PREFIX, then SYSCONFDIR will default to PREFIX/etc.

You may override SYSCONFDIR and/or PREFIX by specifying their corresponding options during configuration:

./waf configure --prefix <path/for/prefix> --sysconfdir <some/other/path>

Running and Configuring NRD

NRD's runtime settings may be modified via configuration file. After installation, a working sample configuration is provided at SYSCONFDIR/ndn/nrd.conf.sample. At startup, NRD will attempt to read the default configuration file from following location: SYSCONFDIR/ndn/nrd.conf.

You may also specify an alternative configuration file location by running NRD with:

nrd --config </path/to/nrd.conf>

Currently, nrd.conf contains only a security section, which is well documented in the sample configuration file.

Starting experiments

  1. Build, install and setup NFD by following the directions provided in README.md in NFD root folder.

  2. Create certificates by following the instructions in NFD's README.md

  3. Build and install NRD by following the directions in INSTALL.md

  4. Create nrd.conf file. You can simply copy the provided sample file in SYSCONFDIR/ndn/nrd.conf.

  5. Setup the trust-anchors in nrd.conf. Ideally, the prefix registration Interest should be signed by application/user key, and this application/user key should be used as trust-anchor. However, currently the default certificate is used to sign the registration Interests. Therefore, for initial testing the default certificate should be set as the trust-anchor. For doing so, the default certificate should be copied in the same folder where the nrd.conf is. Secondly, the trust-anchor should point to the copied certificate in nrd.conf. To know the id of default certificate you can use:

    ~$ ndnsec-get-default

  6. Start NFD (assuming the NFD's conf file exist in SYSCONFDIR/ndn/nfd.conf):

    ~$ nfd

  7. Start NRD (assuming the conf file exist in SYSCONFDIR/ndn/nrd.conf):

    ~$ nrd

  8. Try to connect any application to NFD. For example, producer application that is provided ndn-cpp-dev examples.