Project

General

Profile

Actions

Task #1897

closed

Expand basic documentation and installation instructions for repo-ng

Added by Jeff Burke about 10 years ago. Updated over 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Target version:
-
Start date:
08/20/2014
Due date:
% Done:

100%

Estimated time:

Description

The installation instructions contained in README and INSTALL for repo-ng included in the github site are somewhat incomplete - they assume the user will be able to figure out a number of things based on conventions in other tools like NFD. Please document these explicitly if possible.

Undocumented steps include:

  • Need for and location for configuration file based on the sample.
  • Manual creation of the required /var/db/ndn-repo-ng directory and setting rw permissions for the user that will run repo-ng.
  • Instructions for using ndnputfile and ndngetfile to test the operation of the repo, and any other commnad line examples would be very helpful.
  • Repo-ng installs as if it is a system service with a single db in /var/db, but appears to respect per-user configuration in ~/.ndn/client.conf. This should be documented until support is added to run it as a separate user like NFD.
  • Details of how to configure repo-ng to run as a system service, or as a user other than the current one. This is not yet handled in the Macports installation either, from what I can tell in the portfile in github.
Actions #1

Updated by Weiqi Shi about 10 years ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 100
Actions #2

Updated by Junxiao Shi over 7 years ago

  • Tracker changed from Feature to Task
  • Assignee set to Junxiao Shi

There are some minor problems with the documents, such as Redmine 'https' link. I'll update them.

Actions #3

Updated by Junxiao Shi over 7 years ago

  • Status changed from Resolved to Code review
Actions #4

Updated by Junxiao Shi over 7 years ago

  • Status changed from Code review to Closed
Actions

Also available in: Atom PDF