From 0d1c42b086f3f4f223f4d69fa4edf222fe9f845a Mon Sep 17 00:00:00 2001 From: jeff Date: Fri, 16 Oct 2015 14:11:08 -0400 Subject: [PATCH] fix up docs --- README.md | 15 --------------- doc/database.md | 6 ++++-- doc/running.md | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 39 insertions(+), 17 deletions(-) create mode 100644 doc/running.md diff --git a/README.md b/README.md index bf0d825..5332fd0 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,6 @@ This repository contains resources used by the core daemon which is located [her ## getting started ## -After you [built and installed the daemon](doc/build.md) and [set up your database](doc/database.md), clone this repository and start up the daemon - - # clone it - git clone https://github.com/majestrate/nntpchan ~/nntpchan - cd ~/nntpchan/ - - # set up the workspace - srndv2 setup - - # run the daemon - srndv2 run - - -Then open http://127.0.0.1:18000/ukko.html in your browser. - *PLEASE* report any bugs you find while setting up or building [(here)](https://github.com/majestrate/nntpchan/issues) so that the problems get fixed :^) For peering requests, questions or support find me on [rizon](https://qchat.rizon.net/?channels=#nntpchan) as \__uguu\__ diff --git a/doc/database.md b/doc/database.md index cff3632..304d46c 100644 --- a/doc/database.md +++ b/doc/database.md @@ -19,5 +19,7 @@ You'll get a prompt, enter the following: CREATE DATABASE srnd WITH ENCODING 'UTF8' OWNER srnd; \q -Change the username and password as desired. -The username has to be the same as the database name. +For demo purposes we'll use these credentials. +These are default values, please change them later. + +Now run it, [next](running.md) diff --git a/doc/running.md b/doc/running.md new file mode 100644 index 0000000..130c71d --- /dev/null +++ b/doc/running.md @@ -0,0 +1,35 @@ +## Running + +After you have [built the daemon](build.md) and [configured the database](database.md) you can run the daemon. + + +check out the nntpchan repo + + git clone https://github.com/majestrate/nntpchan + +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 + add_admin=yourpublickeygoeshere + ... # leave the rest of the config values alone for now + + + +run it: + + 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