diff --git a/doc/README.md b/doc/README.md index 1485769..7d92117 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,4 +1,6 @@ NNTPChan Documentation ====================== -Add table of contents +1. [Building NNTPChan](building.md) - Building the source code +2. [Setting up NNTPChan](setting-up.md) - Configuring the node +3. [Running NNTPChan](running.md) - Running the node for the first time diff --git a/doc/build.md b/doc/building.md similarity index 100% rename from doc/build.md rename to doc/building.md diff --git a/doc/running.md b/doc/running.md index ef14184..a7ac3be 100644 --- a/doc/running.md +++ b/doc/running.md @@ -1,39 +1,10 @@ -## Running +Running +======= -After you have [built the daemon](build.md) and [configured the database](database.md) you can run the daemon. +Once you have [built NNTPChan](building.md) and have done [the initial setup you](setting-up.md) you can start NNTPChan. - -check out the nntpchan repo and build the daemon if you already haven't - - git clone https://github.com/majestrate/nntpchan - cd nntpchan - ./build.sh - -set up the daemon: - - ./srndv2 setup - -generate admin keys, don't loose them. - - ./srndv2 tool keygen - -add yourself as admin by adding your ``public key`` to the ``frontend`` section of ``srnd.ini`` - - ... - [frontend] - enable=1 - admin_key=yourpublickeygoeshere - ... # leave the rest of the config values alone for now - - - -run it: +You can now start the NNTP server (srndv2) by running: ./srndv2 run - -Now open the browser up to http://127.0.0.1:18000/ - -To access the mod panel go to the [mod panel](http://127.0.0.1:18000/mod/) and use your ``private key`` to log in - -Now read about [peering](feeds.md) +Now you can check out the web-interface by navigating to 127.0.0.1:18000 (default address - unless you have changed it in your `srnd.ini`) or you can [configure your newsreader]().