From 87097b7a06b2ac0c0a32533b65087171a2293136 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 10:12:09 +0200 Subject: [PATCH 01/91] Update README.md --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index d028fc2..7175e7d 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,7 @@ This repository contains resources used by the core daemon which is located on [ ##Getting started -This is a step-by-step guide for getting up and running with NNTPChan. - -1. [Compile the NNTPChan server](doc/build.md) -2. [Configuring your NNTPChan node](doc/config.md) +[This](doc) is a step-by-step guide for getting up and running with NNTPChan. ##Bugs and issues From b9efd55a572d4707d121807c56724e8a9bced80e Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 10:12:22 +0200 Subject: [PATCH 02/91] Update running.md --- doc/running.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/running.md b/doc/running.md index a7ac3be..6a84e40 100644 --- a/doc/running.md +++ b/doc/running.md @@ -3,8 +3,8 @@ Running Once you have [built NNTPChan](building.md) and have done [the initial setup you](setting-up.md) you can start NNTPChan. -You can now start the NNTP server (srndv2) by running: +You can now start the NNTPChan node (srndv2) by running: ./srndv2 run -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](). +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](configure-newsreader.md). From a57a3b283c06d2a1acb5d5fce0287b12166c347d Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 10:12:42 +0200 Subject: [PATCH 03/91] Create configure-newsreader.md --- doc/configure-newsreader.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 doc/configure-newsreader.md diff --git a/doc/configure-newsreader.md b/doc/configure-newsreader.md new file mode 100644 index 0000000..c2ca2e3 --- /dev/null +++ b/doc/configure-newsreader.md @@ -0,0 +1,4 @@ +Configuring your newsreader +=========================== + +WIP. Let's document both Thunderbird and Pan. From 4de2b159592b4c3701d5d064f1ddd861f3e6143b Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 10:12:50 +0200 Subject: [PATCH 04/91] Update srnd.md --- doc/srnd.md | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 119 insertions(+), 1 deletion(-) diff --git a/doc/srnd.md b/doc/srnd.md index 5574a34..784280a 100644 --- a/doc/srnd.md +++ b/doc/srnd.md @@ -1,4 +1,122 @@ `srnd.ini` ========== -`srnd.ini` is the configuration file for your NNTPChan node. +`srnd.ini` is the configuration file for your NNTPChan node. Some configuration can be done initially through the web-interface (for now hopefully) but there is more that can be done by tweaking your `srnd.ini` file. + +Below is the default state of the file. We will explain each section below. + +```` +[nntp] +instance_name=test.srndv2.tld +bind=127.0.0.1:1199 +sync_on_start=1 +allow_anon=0 +allow_anon_attachments=0 +allow_attachments=1 +require_tls=1 +anon_nntp=0 + +[pprof] +enable=0 +bind=127.0.0.1:17000 + +[crypto] +tls-keyname=overchan +tls-hostname=!!put-hostname-or-ip-of-server-here +tls-trust-dir=certs + +[articles] +store_dir=articles +incoming_dir=/tmp/articles +attachments_dir=webroot/img +thumbs_dir=webroot/thm +convert_bin=/usr/bin/convert +ffmpegthumbnailer_bin=/usr/bin/ffmpeg +sox_bin=/usr/bin/sox +compression=0 + +[database] +type=redis +schema=single +host=localhost +port=6379 +user +password + +[cache] +type=file + +[frontend] +enable=1 +allow_files=1 +regen_on_start=0 +regen_threads=1 +bind=[::]:18000 +name=web.srndv2.test +webroot=webroot +prefix=/ +static_files=contrib +templates=contrib/templates/default +translations=contrib/translations +locale=en +domain=localhost +json-api=0 +json-api-username=fucking-change-this-value +json-api-password=seriously-fucking-change-this-value +api-secret=RTZP5JZ2XGYCY=== +```` + +##`[nntp]` + +All NNTP server-related settings. + +####instance_name + +This is the name for your NNTP server. I don't really know what the point of it is, but hey its there (FIXME). + +####bind + +This is where you put the address and port that you would like the NNTP server to run on where `x` is the address and `y` is the port in `bind=x:y`. + +####sync_on_start + +* When this is set to `1` your NNTP server will sync articles with its peers on startup. +* When this is set to `0` then no syncing will take place on statup. + +####allow_anon + +* When this is set to `1` bluh. +* When this is set to `0` bluh. + +####allow_anon_attachments + +* When this is set to `1` bluh. +* When this is set to `0` bluh. + +####allow_attachments + +* When this is set to `1` posters my attach images to their posts. +* When this is set to `0` posters may not attach images to their posts. + +####require_tls + +* When this is set to `1` then any NNTP connection to this server will need to use TLS. +* When this is set to `0` then any NNTP connection to this server will not need to use TLS (but it could? - FIXME) + +####anon_nntp + +* When this is set to `1` bluh. +* When this is set to `0` bluh. + +##`[pprof]` + +All pprof-related settings. + +####enable + +* When this is set to `1` bluh. +* When this is set to `0` bluh. + +####bind + +FIXME From e868b2c73bbf47ea298d899f7c42072b02913cdf Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 10:13:04 +0200 Subject: [PATCH 05/91] Update README.md --- doc/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/README.md b/doc/README.md index a15707d..206632c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -10,3 +10,4 @@ NNTPChan Documentation ##Developer related 1. [Protocol](protocol.md) +2. [JSON-RPC API](api.md) From a2c33bc649e26e06bbe8f93e85dbfd0056a831eb Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 10:24:31 +0200 Subject: [PATCH 06/91] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7175e7d..d79ca03 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Below is a list of known NNTPChan nodes: Need help? Join us on IRC. 1. [freenode: #nntpchan](https://webchat.freenode.net/?channels=#nntpchan) -2. [rizon: #nntpchan](https://qchat.rizon.net/?channels=#nntpchan) - Most activce +2. [rizon: #nntpchan](https://qchat.rizon.net/?channels=#nntpchan) - Most active ##Donations From a851eddccf707b7e4da509d26fff2fb655c13910 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 10:27:14 +0200 Subject: [PATCH 07/91] Update redis.md --- doc/redis.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/redis.md b/doc/redis.md index 37590b1..a741006 100644 --- a/doc/redis.md +++ b/doc/redis.md @@ -1,14 +1,12 @@ -# configuring redis database backend - +Configuring Redis database +========================== 0) Install redis -Redis 3.x or higher is required, [stable release](http://download.redis.io/releases/redis-stable.tar.gz) recommend +Redis 3.x or higher is required, [stable release](http://download.redis.io/releases/redis-stable.tar.gz) recommended * see http://redis.io/download - - 1) Configuration In srnd.ini the database sections should look like this: From 53046ad1d2e957cde0f2d7bfe57f2e76e8981e7c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:14:19 +0200 Subject: [PATCH 08/91] Update postgres.md --- doc/postgres.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/postgres.md b/doc/postgres.md index aa26a9e..2fc0f38 100644 --- a/doc/postgres.md +++ b/doc/postgres.md @@ -1,3 +1,5 @@ +Configuring Postgres database +============================= Postgres on Debian (as root) From aa9ae3d32f59d629dcb7a4c382266821b3e85b37 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:15:25 +0200 Subject: [PATCH 09/91] Update redis.md --- doc/redis.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/redis.md b/doc/redis.md index a741006..9c877e4 100644 --- a/doc/redis.md +++ b/doc/redis.md @@ -1,13 +1,13 @@ Configuring Redis database ========================== -0) Install redis +##Install redis Redis 3.x or higher is required, [stable release](http://download.redis.io/releases/redis-stable.tar.gz) recommended -* see http://redis.io/download +* See http://redis.io/download -1) Configuration +##Configuration In srnd.ini the database sections should look like this: @@ -19,6 +19,6 @@ In srnd.ini the database sections should look like this: user= password= -2) Run the daemon +##Next step -* see the [next step](running.md) +* See the [Running NNTPChan](running.md) From b020d1330445b58268c708e2c833d753bea63f4c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:15:51 +0200 Subject: [PATCH 10/91] Update postgres.md --- doc/postgres.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/postgres.md b/doc/postgres.md index 2fc0f38..65c72b5 100644 --- a/doc/postgres.md +++ b/doc/postgres.md @@ -23,8 +23,10 @@ You'll get a prompt, enter the following: For demo purposes we'll use these credentials. These are default values, please change them later. -## important +##Important these credentials assume you are going to run using a user called `srnd`, if your username you plan to run the daemon as is different please change `srnd` to your username. -Now run it, [next](running.md) +##Next step + +See the [Running NNTPChan](running.md). From 8ebe2d2d2603bcebd1003d38471c6f34a3883f9a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:15:56 +0200 Subject: [PATCH 11/91] Update redis.md --- doc/redis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/redis.md b/doc/redis.md index 9c877e4..837aec3 100644 --- a/doc/redis.md +++ b/doc/redis.md @@ -21,4 +21,4 @@ In srnd.ini the database sections should look like this: ##Next step -* See the [Running NNTPChan](running.md) +See the [Running NNTPChan](running.md). From 5b06abe63d340d72b4747ed64b68416b1d5dcb3d Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:17:58 +0200 Subject: [PATCH 12/91] Update postgres.md --- doc/postgres.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/postgres.md b/doc/postgres.md index 65c72b5..023a01c 100644 --- a/doc/postgres.md +++ b/doc/postgres.md @@ -1,11 +1,14 @@ Configuring Postgres database ============================= +##Installing Postgres + Postgres on Debian (as root) # install as root apt-get install --no-install-recommends postgresql postgresql-client +##Cibfirguinrg Postgres Setting up postgres (as root) From 51672e81c3066cff9cb94c51fa03aae5ca8709e4 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:18:34 +0200 Subject: [PATCH 13/91] Update redis.md --- doc/redis.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/redis.md b/doc/redis.md index 837aec3..0be278a 100644 --- a/doc/redis.md +++ b/doc/redis.md @@ -1,7 +1,9 @@ Configuring Redis database ========================== -##Install redis +These are instructions for setting up NNTPChan with Redis as the data-storage system. + +##Install Redis Redis 3.x or higher is required, [stable release](http://download.redis.io/releases/redis-stable.tar.gz) recommended From 40d372efe3d06b16e5085fd717999d6e8d3c121a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:18:46 +0200 Subject: [PATCH 14/91] Update postgres.md --- doc/postgres.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/postgres.md b/doc/postgres.md index 023a01c..f683ea5 100644 --- a/doc/postgres.md +++ b/doc/postgres.md @@ -1,6 +1,8 @@ Configuring Postgres database ============================= +These are instructions for setting up NNTPChan with Postgres as the data-storage system. + ##Installing Postgres Postgres on Debian (as root) From 6bb1f4978e81ad7a774b3553e82ef9e060579a9d Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:19:52 +0200 Subject: [PATCH 15/91] Update postgres.md --- doc/postgres.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/postgres.md b/doc/postgres.md index f683ea5..97ef563 100644 --- a/doc/postgres.md +++ b/doc/postgres.md @@ -10,7 +10,7 @@ Postgres on Debian (as root) # install as root apt-get install --no-install-recommends postgresql postgresql-client -##Cibfirguinrg Postgres +##Configuring Postgres Setting up postgres (as root) From fbb14cc719434241069c543e319b3a165abac3c2 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:19:53 +0200 Subject: [PATCH 16/91] Update redis.md --- doc/redis.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/redis.md b/doc/redis.md index 0be278a..4f560ed 100644 --- a/doc/redis.md +++ b/doc/redis.md @@ -3,13 +3,13 @@ Configuring Redis database These are instructions for setting up NNTPChan with Redis as the data-storage system. -##Install Redis +##Installing Redis Redis 3.x or higher is required, [stable release](http://download.redis.io/releases/redis-stable.tar.gz) recommended * See http://redis.io/download -##Configuration +##Configuring Redis In srnd.ini the database sections should look like this: From d20de6b9b581faaaf491a5a3483fffbbec288c45 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:20:06 +0200 Subject: [PATCH 17/91] Update postgres.md --- doc/postgres.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/postgres.md b/doc/postgres.md index 97ef563..6454f51 100644 --- a/doc/postgres.md +++ b/doc/postgres.md @@ -28,9 +28,9 @@ You'll get a prompt, enter the following: For demo purposes we'll use these credentials. These are default values, please change them later. -##Important +###Important -these credentials assume you are going to run using a user called `srnd`, if your username you plan to run the daemon as is different please change `srnd` to your username. +These credentials assume you are going to run using a user called `srnd`, if your username you plan to run the daemon as is different please change `srnd` to your username. ##Next step From 6d20a991f87b7011da21d8fca6847534ec9605b6 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:20:25 +0200 Subject: [PATCH 18/91] Update redis.md --- doc/redis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/redis.md b/doc/redis.md index 4f560ed..45fd6a1 100644 --- a/doc/redis.md +++ b/doc/redis.md @@ -11,7 +11,7 @@ Redis 3.x or higher is required, [stable release](http://download.redis.io/relea ##Configuring Redis -In srnd.ini the database sections should look like this: +In `srnd.ini` the database sections should look like this: [database] type=redis From 6e2f245f24f7252df9d851744a9bfc8abe233e4f Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:23:09 +0200 Subject: [PATCH 19/91] Update configuration.md --- doc/configuration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/configuration.md b/doc/configuration.md index 29fe67b..0e01b52 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -1,9 +1,9 @@ -# Configuration # +Configuration Files +=================== -In nntpchan's stack there are currently 2 configuration files. +In NNTPChan's stack there are currently 2 configuration files. All config files are auto generated with sane defaults if the files are not present. -[feeds.ini](feeds.md) is for all your nntp outfeeds - -[srnd.ini](srnd.md) is for the core daemon +1. [srnd.ini](srnd.md) is for the core daemon +2. [feeds.ini](feeds.md) is for all your nntp outfeeds From a9403410c8100c6b537329fd367179156c337da4 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:24:13 +0200 Subject: [PATCH 20/91] Update feeds.md --- doc/feeds.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/doc/feeds.md b/doc/feeds.md index efd60ea..faf8dca 100644 --- a/doc/feeds.md +++ b/doc/feeds.md @@ -1,10 +1,11 @@ -# feeds.ini # +`feeds.ini` +=========== -## Peering ## +##Peering In order to actually be distributed, you need another person to sync posts with, otherwise what's the point right? -### Peering over the regular internet with tls ### +###Peering over the regular internet with TLS Requirements: @@ -53,7 +54,7 @@ If Alice owns `nntp.alice.net` and Bob owns `nntp.bob.com` and are both using po overchan.* = 1 ctl = 1 -each side's `certs` directory contains 2 files: +Each side's `certs` directory contains 2 files: * overchan-alice-nntp.alice.net.crt (alice's certificate) * overchan-bob-nntp.bob.com.crt (bob's certificate) @@ -63,7 +64,7 @@ Alice keeps `overchan-alice-nntp.alice.net.key` secret and never shares it Bob keeps `overchan-bob-nntp.bob.com.key` secret and never shares it -### Peering Authentication with passwords ### +###Peering Authentication with passwords adding / removing credentials via the command line: @@ -91,7 +92,7 @@ exmaple feeds.ini: ctl = 1 -### Peering over tor ### +###Peering over Tor Install tor @@ -125,9 +126,9 @@ Then to peer with someone over tor add this to you feeds.ini ctl=1 -## Options ## +##Options -#### You need one connection and one settings block for each connection #### +####You need one connection and one settings block for each connection Here is an example entry in feeds.ini @@ -161,7 +162,7 @@ Proxy settings, straight forward. Supported proxy types are `socks4a` and `none` [them.onion] -nntp synchronization settings +NNTP synchronization settings overchan=1 From 191dbc860cfff5f4019a8201f34c0689f55cfd25 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:26:03 +0200 Subject: [PATCH 21/91] Update setting-up.md --- doc/setting-up.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index b726a0d..7d78067 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -31,7 +31,7 @@ If you have chosen Redis then fill in the fields below: ![Image 3](http://i.imgur.com/WPXedZB.png) -If you have chosen PostgreSQL then fill in the fields below: +If you have chosen PostgreSQL then fill in the fields below (but first [Configure Postgres database](postgres.md): * **Hostname or IP Address** - This is the hostname or IP address of your PostreSQL server (I would run it locally on 127.0.0.1 to be safe). * **Port number** - This is the port that your PostgreSQL server is running on. From 279e9c18c98b322db960dd070ebba446c66c1490 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:26:57 +0200 Subject: [PATCH 22/91] Update setting-up.md --- doc/setting-up.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index 7d78067..eb04752 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -31,7 +31,9 @@ If you have chosen Redis then fill in the fields below: ![Image 3](http://i.imgur.com/WPXedZB.png) -If you have chosen PostgreSQL then fill in the fields below (but first [Configure Postgres database](postgres.md): +**First** [Install and Configure Postgres database](postgres.md). + +If you have chosen PostgreSQL then fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your PostreSQL server (I would run it locally on 127.0.0.1 to be safe). * **Port number** - This is the port that your PostgreSQL server is running on. From e057ee1812c17d061336d379bcefa10707b45a4a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:27:37 +0200 Subject: [PATCH 23/91] Update setting-up.md --- doc/setting-up.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index eb04752..f457fda 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -19,7 +19,8 @@ First your will be asked what data-storage system you would like to use. We supp ![Image 2](http://i.imgur.com/HDp4Ddf.png) -If you have chosen Redis then fill in the fields below: +**First** [Install and Configure Redis database](redis.md). +**Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your Redis server (I would run it locally on 127.0.0.1 to be safe). * **Port number** - The port that your Redis server is running on. @@ -32,8 +33,7 @@ If you have chosen Redis then fill in the fields below: ![Image 3](http://i.imgur.com/WPXedZB.png) **First** [Install and Configure Postgres database](postgres.md). - -If you have chosen PostgreSQL then fill in the fields below: +**Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your PostreSQL server (I would run it locally on 127.0.0.1 to be safe). * **Port number** - This is the port that your PostgreSQL server is running on. From 6eb84bf55e1997ecb3f7007a4afcd038391598c7 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:28:08 +0200 Subject: [PATCH 24/91] Update and rename doc/database.md to doc/trash/database.md --- doc/{ => trash}/database.md | 2 ++ 1 file changed, 2 insertions(+) rename doc/{ => trash}/database.md (69%) diff --git a/doc/database.md b/doc/trash/database.md similarity index 69% rename from doc/database.md rename to doc/trash/database.md index 5f2245e..13e0008 100644 --- a/doc/database.md +++ b/doc/trash/database.md @@ -3,3 +3,5 @@ You have 2 choices for database backend: * [postgres](postgres.md) * [redis](redis.md) + +NOTE: we don't need this file no more From 5f0a353482f6771ae1c80181c6eb0d3f578eddf3 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:28:37 +0200 Subject: [PATCH 25/91] Rename redis.md to install-and-configure-redis.md --- doc/{redis.md => install-and-configure-redis.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{redis.md => install-and-configure-redis.md} (100%) diff --git a/doc/redis.md b/doc/install-and-configure-redis.md similarity index 100% rename from doc/redis.md rename to doc/install-and-configure-redis.md From 71b46ef1f237f9d47c102dd3f2a5b2f6e65bff6b Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:29:01 +0200 Subject: [PATCH 26/91] Update setting-up.md --- doc/setting-up.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index f457fda..e4ceaed 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -19,7 +19,7 @@ First your will be asked what data-storage system you would like to use. We supp ![Image 2](http://i.imgur.com/HDp4Ddf.png) -**First** [Install and Configure Redis database](redis.md). +**First** [Install and Configure Redis database](install-and-configure-redis.md). **Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your Redis server (I would run it locally on 127.0.0.1 to be safe). From 9583b80ac533f4c99e62e6bdec48ac6328195d82 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:29:14 +0200 Subject: [PATCH 27/91] Rename postgres.md to install-and-configure-postgres.md --- doc/{postgres.md => install-and-configure-postgres.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{postgres.md => install-and-configure-postgres.md} (100%) diff --git a/doc/postgres.md b/doc/install-and-configure-postgres.md similarity index 100% rename from doc/postgres.md rename to doc/install-and-configure-postgres.md From b32ff7b6ac1b5ab6787f5d87f3268095d5ae6795 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:29:59 +0200 Subject: [PATCH 28/91] Rename doc/install-and-configure-redis.md to doc/database/redis/install-and-configure-redis.md --- doc/{ => database/redis}/install-and-configure-redis.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{ => database/redis}/install-and-configure-redis.md (100%) diff --git a/doc/install-and-configure-redis.md b/doc/database/redis/install-and-configure-redis.md similarity index 100% rename from doc/install-and-configure-redis.md rename to doc/database/redis/install-and-configure-redis.md From 2d39c33f05ba37e1595ec13d9059ce7b5968dc37 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:30:00 +0200 Subject: [PATCH 29/91] Rename doc/install-and-configure-postgres.md to doc/database/postgres/install-and-configure-postgres.md --- doc/{ => database/postgres}/install-and-configure-postgres.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{ => database/postgres}/install-and-configure-postgres.md (100%) diff --git a/doc/install-and-configure-postgres.md b/doc/database/postgres/install-and-configure-postgres.md similarity index 100% rename from doc/install-and-configure-postgres.md rename to doc/database/postgres/install-and-configure-postgres.md From 6631b881b0aab05548c6444ec1343ecf3a41bae0 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:30:00 +0200 Subject: [PATCH 30/91] Rename doc/securing-redis.md to doc/database/redis/securing-redis.md --- doc/{ => database/redis}/securing-redis.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{ => database/redis}/securing-redis.md (100%) diff --git a/doc/securing-redis.md b/doc/database/redis/securing-redis.md similarity index 100% rename from doc/securing-redis.md rename to doc/database/redis/securing-redis.md From 543108e0d649ff41fcbf88b14416cd5389915e43 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:30:20 +0200 Subject: [PATCH 31/91] Update setting-up.md --- doc/setting-up.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index e4ceaed..a16fe18 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -19,12 +19,12 @@ First your will be asked what data-storage system you would like to use. We supp ![Image 2](http://i.imgur.com/HDp4Ddf.png) -**First** [Install and Configure Redis database](install-and-configure-redis.md). +**First** [Install and Configure Redis database](database/redis/install-and-configure-redis.md). **Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your Redis server (I would run it locally on 127.0.0.1 to be safe). * **Port number** - The port that your Redis server is running on. -* **Password** - Optional authentication password for Redis ([Setting up a Redis password](securing-redis.md)). +* **Password** - Optional authentication password for Redis ([Setting up a Redis password](database/redis/securing-redis.md)).
@@ -32,7 +32,7 @@ First your will be asked what data-storage system you would like to use. We supp ![Image 3](http://i.imgur.com/WPXedZB.png) -**First** [Install and Configure Postgres database](postgres.md). +**First** [Install and Configure Postgres database](database/postgres/postgres.md). **Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your PostreSQL server (I would run it locally on 127.0.0.1 to be safe). From c4f8fd118d9b1ba34d20f13b79fcd75e2b1c46b0 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:31:08 +0200 Subject: [PATCH 32/91] Update install-and-configure-redis.md --- doc/database/redis/install-and-configure-redis.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/database/redis/install-and-configure-redis.md b/doc/database/redis/install-and-configure-redis.md index 45fd6a1..dcd43a0 100644 --- a/doc/database/redis/install-and-configure-redis.md +++ b/doc/database/redis/install-and-configure-redis.md @@ -21,6 +21,10 @@ In `srnd.ini` the database sections should look like this: user= password= +##Securing Redis (optional) + +Read [Securing Redis](securing-redis.md) for adding password authentication to your Redis server. + ##Next step See the [Running NNTPChan](running.md). From 316729774aed6ed67a5d5bdb0687a6899384a277 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:33:06 +0200 Subject: [PATCH 33/91] Update and rename doc/api.md to doc/developer/api.md --- doc/{ => developer}/api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) rename doc/{ => developer}/api.md (85%) diff --git a/doc/api.md b/doc/developer/api.md similarity index 85% rename from doc/api.md rename to doc/developer/api.md index 36530eb..905c5e8 100644 --- a/doc/api.md +++ b/doc/developer/api.md @@ -1,4 +1,5 @@ -# nntpchan jsonrpc api +NNTPChan JSON-RPC API +===================== To enable set the following in `srnd.ini` section `frontend` From 6092f4e78ed3b027b16d0d268c26a7fd37011a2a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:33:08 +0200 Subject: [PATCH 34/91] Update and rename doc/protocol.md to doc/developer/protocol.md --- doc/{ => developer}/protocol.md | 2 ++ 1 file changed, 2 insertions(+) rename doc/{ => developer}/protocol.md (99%) diff --git a/doc/protocol.md b/doc/developer/protocol.md similarity index 99% rename from doc/protocol.md rename to doc/developer/protocol.md index 00c8928..bb3b8ff 100644 --- a/doc/protocol.md +++ b/doc/developer/protocol.md @@ -1,6 +1,8 @@ Protocol ======== +Documentation of the NNTPChan protocol. + ##Preface NNTPChan is a newsgroup meant to be served on web frontends in an effort to create a decentralized imageboard. Moderation takes place on each frontend itself. Message and image transport is using MIME multipart messages and Base64 as encoding for Images. All messages need to be valid NNTP messages, the transport of messages need to follow NNTP specifications. It is possible to use an existing NNTP daemon like INN or to implement the NNTP sync part as well. From ecb462c0c369a426fcc0887e7cd375090e1ce1e4 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:33:29 +0200 Subject: [PATCH 35/91] Update README.md --- doc/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index 206632c..89c560e 100644 --- a/doc/README.md +++ b/doc/README.md @@ -9,5 +9,5 @@ NNTPChan Documentation ##Developer related -1. [Protocol](protocol.md) -2. [JSON-RPC API](api.md) +1. [Protocol](developer/protocol.md) +2. [JSON-RPC API](developer/api.md) From 0831c250c452c5c79e490fca27e1e083e5bee2d9 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:34:06 +0200 Subject: [PATCH 36/91] Rename doc/trash/database.md to doc/.trash/database.md --- doc/{trash => .trash}/database.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{trash => .trash}/database.md (100%) diff --git a/doc/trash/database.md b/doc/.trash/database.md similarity index 100% rename from doc/trash/database.md rename to doc/.trash/database.md From 1f4e6c8ecb2bd741147f9c4f3457e25f2ce2f54f Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:34:54 +0200 Subject: [PATCH 37/91] Update README.md --- doc/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/README.md b/doc/README.md index 89c560e..c7680fd 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,6 +6,7 @@ NNTPChan Documentation 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 +4. [Manaing your NNTPChan node with the CLI](cli.md) ##Developer related From 705f3b9df0ac3132d8ec3203511fcac5172d9dae Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:35:14 +0200 Subject: [PATCH 38/91] Update README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index c7680fd..673cab0 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,7 +6,7 @@ NNTPChan Documentation 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 -4. [Manaing your NNTPChan node with the CLI](cli.md) +4. [Managing your NNTPChan node with the CLI](cli.md) ##Developer related From e45c172e621e332dabc5caae8f32385b6f221406 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:35:34 +0200 Subject: [PATCH 39/91] Update README.md --- doc/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/README.md b/doc/README.md index 673cab0..c71bfe0 100644 --- a/doc/README.md +++ b/doc/README.md @@ -7,6 +7,7 @@ NNTPChan Documentation 2. [Setting up NNTPChan](setting-up.md) - Configuring the node 3. [Running NNTPChan](running.md) - Running the node for the first time 4. [Managing your NNTPChan node with the CLI](cli.md) +5. [Configuring your news reader for NNTPCHan](configure-newsreader.md) ##Developer related From 38f9db2f5700c355b0cca5fb68fcd33b041354ac Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:35:42 +0200 Subject: [PATCH 40/91] Update README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index c71bfe0..b45cfd3 100644 --- a/doc/README.md +++ b/doc/README.md @@ -7,7 +7,7 @@ NNTPChan Documentation 2. [Setting up NNTPChan](setting-up.md) - Configuring the node 3. [Running NNTPChan](running.md) - Running the node for the first time 4. [Managing your NNTPChan node with the CLI](cli.md) -5. [Configuring your news reader for NNTPCHan](configure-newsreader.md) +5. [Configuring your news reader for NNTPChan](configure-newsreader.md) ##Developer related From ef124fe7f23096982e89197e2a84fc86a0d17dd0 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:36:04 +0200 Subject: [PATCH 41/91] Update README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index b45cfd3..f6412d9 100644 --- a/doc/README.md +++ b/doc/README.md @@ -7,7 +7,7 @@ NNTPChan Documentation 2. [Setting up NNTPChan](setting-up.md) - Configuring the node 3. [Running NNTPChan](running.md) - Running the node for the first time 4. [Managing your NNTPChan node with the CLI](cli.md) -5. [Configuring your news reader for NNTPChan](configure-newsreader.md) +5. [Configuring your news reader for NNTPChan](configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and read artciles ##Developer related From b3d346c61f45ee87e1c116568d8c2945798f35ee Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:36:12 +0200 Subject: [PATCH 42/91] Update README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index f6412d9..756cbad 100644 --- a/doc/README.md +++ b/doc/README.md @@ -7,7 +7,7 @@ NNTPChan Documentation 2. [Setting up NNTPChan](setting-up.md) - Configuring the node 3. [Running NNTPChan](running.md) - Running the node for the first time 4. [Managing your NNTPChan node with the CLI](cli.md) -5. [Configuring your news reader for NNTPChan](configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and read artciles +5. [Configuring your news reader for NNTPChan](configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and read articles ##Developer related From edd44c73bf810128941cc7a958b5368ad9083096 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:36:30 +0200 Subject: [PATCH 43/91] Update README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 756cbad..e091592 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,7 +6,7 @@ NNTPChan Documentation 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 -4. [Managing your NNTPChan node with the CLI](cli.md) +4. [Managing your NNTPChan node with the CLI](cli.md) - Manage many aspects of your node via the command-line interface 5. [Configuring your news reader for NNTPChan](configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and read articles ##Developer related From 8a1936fade99f7fe0f626919c140781c93ae28db Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:37:33 +0200 Subject: [PATCH 44/91] Update README.md --- doc/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index e091592..e661415 100644 --- a/doc/README.md +++ b/doc/README.md @@ -11,5 +11,5 @@ NNTPChan Documentation ##Developer related -1. [Protocol](developer/protocol.md) -2. [JSON-RPC API](developer/api.md) +1. [Protocol](developer/protocol.md) - NNTPChan's protocol specification +2. [JSON-RPC API](developer/api.md) - NNTPChan's JSON-RPC API From 32eae178fb03b1d64fbdf355a080f6a0952c21cd Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:37:55 +0200 Subject: [PATCH 45/91] Update README.md --- doc/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/README.md b/doc/README.md index e661415..1f9564d 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,6 +1,8 @@ NNTPChan Documentation ====================== +Hey, welcome to the documentation. This will help you use and develop with NNTPChan. + ##End-user related 1. [Building NNTPChan](building.md) - Building the source code From c92b78c7549dca8385acde8183c418cd7a1228af Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:38:25 +0200 Subject: [PATCH 46/91] Rename configuration.md to configuration-files.md --- doc/{configuration.md => configuration-files.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{configuration.md => configuration-files.md} (100%) diff --git a/doc/configuration.md b/doc/configuration-files.md similarity index 100% rename from doc/configuration.md rename to doc/configuration-files.md From 6e029cea0d30e1808e54ed01601d9fee84189e15 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:39:43 +0200 Subject: [PATCH 47/91] Update README.md --- doc/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/README.md b/doc/README.md index 1f9564d..e3c1f65 100644 --- a/doc/README.md +++ b/doc/README.md @@ -15,3 +15,9 @@ Hey, welcome to the documentation. This will help you use and develop with NNTPC 1. [Protocol](developer/protocol.md) - NNTPChan's protocol specification 2. [JSON-RPC API](developer/api.md) - NNTPChan's JSON-RPC API + +TO-ADD: + +1. [Configuration files](configuration-files.md) + 1. [srnd.ini](srnd.md) + 2. [feeds.ini](feeds.md) From cc382572c632bcc0f97ddd051ad10430c74b8482 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:57:37 +0200 Subject: [PATCH 48/91] Update setting-up.md --- doc/setting-up.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index a16fe18..c360a07 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -75,4 +75,10 @@ NNTPChan needs to know the paths to the listed programs on your system. ##Manual configuration (WIP) -FIXME +Check out the following in order: + +* Setting up data-storage system (choose i or ii) + 1. [Setting up using Postgres](database/postgres/install-and-configure-postgres.md) + 2. [Setting up using Redis](database/postgres/install-and-configure-redis.md) +* [Setting up NNTPChan system](srnd.md) +* [Setting up feeds](feeds.md) From 21566eb0d99f0ea9b32f64db58af38df3acbfcac Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:57:49 +0200 Subject: [PATCH 49/91] Update setting-up.md --- doc/setting-up.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index c360a07..5b205da 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -77,8 +77,8 @@ NNTPChan needs to know the paths to the listed programs on your system. Check out the following in order: -* Setting up data-storage system (choose i or ii) +1. Setting up data-storage system (choose i or ii) 1. [Setting up using Postgres](database/postgres/install-and-configure-postgres.md) 2. [Setting up using Redis](database/postgres/install-and-configure-redis.md) -* [Setting up NNTPChan system](srnd.md) -* [Setting up feeds](feeds.md) +2. [Setting up NNTPChan system](srnd.md) +3. [Setting up feeds](feeds.md) From 91b6dbe9b21eb94fc5aa94065a393781ecede4dc Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:58:12 +0200 Subject: [PATCH 50/91] Update setting-up.md --- doc/setting-up.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index 5b205da..8f705eb 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -79,6 +79,6 @@ Check out the following in order: 1. Setting up data-storage system (choose i or ii) 1. [Setting up using Postgres](database/postgres/install-and-configure-postgres.md) - 2. [Setting up using Redis](database/postgres/install-and-configure-redis.md) + 2. [Setting up using Redis](database/redis/install-and-configure-redis.md) 2. [Setting up NNTPChan system](srnd.md) 3. [Setting up feeds](feeds.md) From 7c668c5184a93d80c2f3b19ad8c5f40bcba02bb6 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:58:38 +0200 Subject: [PATCH 51/91] Update install-and-configure-postgres.md --- doc/database/postgres/install-and-configure-postgres.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc/database/postgres/install-and-configure-postgres.md b/doc/database/postgres/install-and-configure-postgres.md index 6454f51..75d98c9 100644 --- a/doc/database/postgres/install-and-configure-postgres.md +++ b/doc/database/postgres/install-and-configure-postgres.md @@ -31,7 +31,3 @@ These are default values, please change them later. ###Important These credentials assume you are going to run using a user called `srnd`, if your username you plan to run the daemon as is different please change `srnd` to your username. - -##Next step - -See the [Running NNTPChan](running.md). From 22e384f2d19465994b92ced933a5fd858208ae19 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 11:58:50 +0200 Subject: [PATCH 52/91] Update install-and-configure-redis.md --- doc/database/redis/install-and-configure-redis.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc/database/redis/install-and-configure-redis.md b/doc/database/redis/install-and-configure-redis.md index dcd43a0..3b635ae 100644 --- a/doc/database/redis/install-and-configure-redis.md +++ b/doc/database/redis/install-and-configure-redis.md @@ -24,7 +24,3 @@ In `srnd.ini` the database sections should look like this: ##Securing Redis (optional) Read [Securing Redis](securing-redis.md) for adding password authentication to your Redis server. - -##Next step - -See the [Running NNTPChan](running.md). From 9a6a4247ce99dee0803262d457108c0a9d1d5a87 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:00:46 +0200 Subject: [PATCH 53/91] Update README.md --- doc/README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/doc/README.md b/doc/README.md index e3c1f65..1f9564d 100644 --- a/doc/README.md +++ b/doc/README.md @@ -15,9 +15,3 @@ Hey, welcome to the documentation. This will help you use and develop with NNTPC 1. [Protocol](developer/protocol.md) - NNTPChan's protocol specification 2. [JSON-RPC API](developer/api.md) - NNTPChan's JSON-RPC API - -TO-ADD: - -1. [Configuration files](configuration-files.md) - 1. [srnd.ini](srnd.md) - 2. [feeds.ini](feeds.md) From 0ac0d7d1ff18c104daffa4669a129e484a861e6b Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:02:31 +0200 Subject: [PATCH 54/91] Update building.md --- doc/building.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc/building.md b/doc/building.md index ec76253..b60dbda 100644 --- a/doc/building.md +++ b/doc/building.md @@ -46,7 +46,3 @@ If you want to compile with Redis support (recommended - Redis is easy to use) t If you want to build without support for Redis then build with the `--no-redis` flag: ./build.sh --no-redis - -##Now let's setup NNTPChan - -Check out [Configuring NNTPChan](config.md). From e0f15b73fb15165fc36cec371eb65f445161e6e4 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:04:22 +0200 Subject: [PATCH 55/91] Rename doc/configuration-files.md to doc/.trash/configuration-files.md --- doc/{ => .trash}/configuration-files.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{ => .trash}/configuration-files.md (100%) diff --git a/doc/configuration-files.md b/doc/.trash/configuration-files.md similarity index 100% rename from doc/configuration-files.md rename to doc/.trash/configuration-files.md From 594cc4929a4bea846f9b4378f5133e33fced4eb6 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:04:55 +0200 Subject: [PATCH 56/91] Update setting-up.md --- doc/setting-up.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index 8f705eb..8627312 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -1,5 +1,5 @@ -Configuring NNTPChan server -=========================== +Configuring NNTPChan +==================== This document provides a step-by-step guide to configurin your NNTPChan node. From acc727b9012376f18edee5ff6b634341380d7396 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:05:21 +0200 Subject: [PATCH 57/91] Update setting-up.md --- doc/setting-up.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/setting-up.md b/doc/setting-up.md index 8627312..a5a497f 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -7,6 +7,8 @@ This document provides a step-by-step guide to configurin your NNTPChan node. You can configure NNTPChan via the web-interface by navigating your browser to http://127.0.0.1:18000. +
+ ###Selecting your data-storage system ![Image 1](http://i.imgur.com/l9iiXxB.png) From 6ea1b2d3b400a472ff9beab3f7e607fb9734fe7c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:06:25 +0200 Subject: [PATCH 58/91] Update setting-up.md --- doc/setting-up.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index a5a497f..3017d11 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -13,7 +13,7 @@ You can configure NNTPChan via the web-interface by navigating your browser to h ![Image 1](http://i.imgur.com/l9iiXxB.png) -First your will be asked what data-storage system you would like to use. We support Redis and PostgreSQL. +First your will be asked what data-storage system you would like to use. We support Redis and Postgres. Below we have configuration information for both Redis and Postgres.
@@ -30,7 +30,7 @@ First your will be asked what data-storage system you would like to use. We supp
-####PostgreSQL configuration +####Postgres configuration ![Image 3](http://i.imgur.com/WPXedZB.png) @@ -38,9 +38,9 @@ First your will be asked what data-storage system you would like to use. We supp **Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your PostreSQL server (I would run it locally on 127.0.0.1 to be safe). -* **Port number** - This is the port that your PostgreSQL server is running on. -* **Username** - The username for PostgreSQL. -* **Password** - The password for PostgreSQL. +* **Port number** - This is the port that your Postgres server is running on. +* **Username** - The username for Postgres. +* **Password** - The password for Postgres.
From 9f9bebf99cef5fb77990ea4d25b6415abd4148ad Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:07:22 +0200 Subject: [PATCH 59/91] Update setting-up.md --- doc/setting-up.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index 3017d11..2c63a5b 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -37,7 +37,7 @@ First your will be asked what data-storage system you would like to use. We supp **First** [Install and Configure Postgres database](database/postgres/postgres.md). **Then** fill in the fields below: -* **Hostname or IP Address** - This is the hostname or IP address of your PostreSQL server (I would run it locally on 127.0.0.1 to be safe). +* **Hostname or IP Address** - This is the hostname or IP address of your Postres server (I would run it locally on 127.0.0.1 to be safe). * **Port number** - This is the port that your Postgres server is running on. * **Username** - The username for Postgres. * **Password** - The password for Postgres. From c5cf5ba4f97e3be7401cc75e92815ea01098ca4a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:08:21 +0200 Subject: [PATCH 60/91] Rename doc/configure-newsreader.md to doc/extras/configure-newsreader.md --- doc/{ => extras}/configure-newsreader.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{ => extras}/configure-newsreader.md (100%) diff --git a/doc/configure-newsreader.md b/doc/extras/configure-newsreader.md similarity index 100% rename from doc/configure-newsreader.md rename to doc/extras/configure-newsreader.md From a17f91fea19fba64667d94ecbdb82a9105170323 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:08:36 +0200 Subject: [PATCH 61/91] Update README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 1f9564d..3165343 100644 --- a/doc/README.md +++ b/doc/README.md @@ -9,7 +9,7 @@ Hey, welcome to the documentation. This will help you use and develop with NNTPC 2. [Setting up NNTPChan](setting-up.md) - Configuring the node 3. [Running NNTPChan](running.md) - Running the node for the first time 4. [Managing your NNTPChan node with the CLI](cli.md) - Manage many aspects of your node via the command-line interface -5. [Configuring your news reader for NNTPChan](configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and read articles +5. [Configuring your news reader for NNTPChan](extras/configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and read articles ##Developer related From 68d7ec783df21ba6baeb876f731877cd1b9b058d Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:08:52 +0200 Subject: [PATCH 62/91] Update running.md --- doc/running.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/running.md b/doc/running.md index 6a84e40..28fad70 100644 --- a/doc/running.md +++ b/doc/running.md @@ -7,4 +7,4 @@ You can now start the NNTPChan node (srndv2) by running: ./srndv2 run -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](configure-newsreader.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](extras/configure-newsreader.md). From ff745ada70ffc879649df854b7bcbb957aa17020 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:11:04 +0200 Subject: [PATCH 63/91] Update running.md --- doc/running.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/running.md b/doc/running.md index 28fad70..ea81ab8 100644 --- a/doc/running.md +++ b/doc/running.md @@ -1,5 +1,5 @@ -Running -======= +Running NNTPChan +================ Once you have [built NNTPChan](building.md) and have done [the initial setup you](setting-up.md) you can start NNTPChan. From 880d1e10e38deb552a394763cfe4fdacf077679f Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:11:40 +0200 Subject: [PATCH 64/91] Update running.md --- doc/running.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/running.md b/doc/running.md index ea81ab8..ef77f97 100644 --- a/doc/running.md +++ b/doc/running.md @@ -1,7 +1,7 @@ Running NNTPChan ================ -Once you have [built NNTPChan](building.md) and have done [the initial setup you](setting-up.md) you can start NNTPChan. +Once you have [built NNTPChan](building.md) and done [the initial setup you](setting-up.md) you can start NNTPChan. You can now start the NNTPChan node (srndv2) by running: From 9f8ce5ab9559948dceede2ac6f2708707173300e Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:12:05 +0200 Subject: [PATCH 65/91] Update cli.md --- doc/cli.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/cli.md b/doc/cli.md index 5c4ea32..089d845 100644 --- a/doc/cli.md +++ b/doc/cli.md @@ -6,32 +6,32 @@ To rebuild all thumbnails run: - srndv2 tool rethumb + ./srndv2 tool rethumb ##Generate a new tripcode keypair (prints to stdout) - srndv2 tool keygen + ./srndv2 tool keygen ##Add a public key to moderation trust Where `publickey` is the public key to be added. - srndv2 tool mod add publickey + ./srndv2 tool mod add publickey ##Remove a public key from moderation trust Where `publickey` is the public key to be removed. - srndv2 tool mod del publickey + ./srndv2 tool mod del publickey ##Add a new NNTP user Where `username` is the username and `password` is the user's password for the new uer. - srndv2 tool nntp add-login username password + ./srndv2 tool nntp add-login username password ##Remove an existing NNTP user Where `username` is the username of the user to be deleted. - srndv2 tool nntp del-login username + ./srndv2 tool nntp del-login username From a01d5b0cee25efc137202ab63f11bf89b22735ad Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:13:10 +0200 Subject: [PATCH 66/91] Update README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 3165343..2bf09f9 100644 --- a/doc/README.md +++ b/doc/README.md @@ -9,7 +9,7 @@ Hey, welcome to the documentation. This will help you use and develop with NNTPC 2. [Setting up NNTPChan](setting-up.md) - Configuring the node 3. [Running NNTPChan](running.md) - Running the node for the first time 4. [Managing your NNTPChan node with the CLI](cli.md) - Manage many aspects of your node via the command-line interface -5. [Configuring your news reader for NNTPChan](extras/configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and read articles +5. [Configuring your news reader for NNTPChan](extras/configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and receive articles from your node. ##Developer related From a4a4eb7c2a97f52f030030d7f1f5e6681acd1af2 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 12:59:26 +0200 Subject: [PATCH 67/91] Update srnd.go --- srnd.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/srnd.go b/srnd.go index f65f455..83cdbc8 100644 --- a/srnd.go +++ b/srnd.go @@ -17,7 +17,7 @@ func main() { if action == "setup" { log.Println("Setting up SRNd base...") daemon.Setup() - log.Println("Setup Done") + log.Println("\nSetup Completed.") } else if action == "run" { log.Printf("Starting up %s...", srnd.Version()) daemon.Setup() From a425ffea8f1a2c30e4ee4c027c648fd7c22087de Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:11:16 +0200 Subject: [PATCH 68/91] Update building.md --- doc/building.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/doc/building.md b/doc/building.md index b60dbda..8cffaba 100644 --- a/doc/building.md +++ b/doc/building.md @@ -46,3 +46,37 @@ If you want to compile with Redis support (recommended - Redis is easy to use) t If you want to build without support for Redis then build with the `--no-redis` flag: ./build.sh --no-redis + +##Trisquel instructions + +These are installation instructions for Trisquel. + +###Installing dependancies + +####Standard install + + sudo apt-get update + sudo apt-get --no-install-recommends install imagemagick libsodium-dev sox build-essential git ca-certificates + +####Compiling and installing `ffmpeg` (`ffmpeg` is not available in Trisquel repos) + +This will install `ffmpeg` to `/sur/local/bin/ffmpeg`: + + git clone https://git.ffmpeg.org/ffmpeg.git ffmpeg --depth=1 + cd ffmpeg + ./configure --disable-yasm + make + sudo make install + rm -rf ffmpeg + +###Install Go + +Run this to install Go. + + sudo apt-get install golang-1.6 + +###Installing Redis + +Run this to install Redis. + + sudo apt-get install redis-server From 9042f0f3b04bd2735f779658dc4d8352903e3729 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:13:14 +0200 Subject: [PATCH 69/91] Update building.md --- doc/building.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/doc/building.md b/doc/building.md index 8cffaba..9be2fce 100644 --- a/doc/building.md +++ b/doc/building.md @@ -53,7 +53,7 @@ These are installation instructions for Trisquel. ###Installing dependancies -####Standard install +####Standard dependancies sudo apt-get update sudo apt-get --no-install-recommends install imagemagick libsodium-dev sox build-essential git ca-certificates @@ -80,3 +80,24 @@ Run this to install Go. Run this to install Redis. sudo apt-get install redis-server + +###Installing Postgres (WIP) + +Run this to install Postgres. + + sudo apt-get install Postgres + +###Get the NNTPChan source + + git clone https://github.com/majestrate/nntpchan --depth=1 + cd nntpchan + +###Now compile! + +If you want to compile with Redis support (recommended - Redis is easy to use) then run: + + ./build.sh + +If you want to build without support for Redis then build with the `--no-redis` flag: + + ./build.sh --no-redis From 8aed629be64568182a2f118627a4d98c2a8871d9 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:15:37 +0200 Subject: [PATCH 70/91] Update building.md --- doc/building.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/doc/building.md b/doc/building.md index 9be2fce..0d4bd98 100644 --- a/doc/building.md +++ b/doc/building.md @@ -51,14 +51,18 @@ If you want to build without support for Redis then build with the `--no-redis` These are installation instructions for Trisquel. -###Installing dependancies +###Install Go -####Standard dependancies +Run this to install Go. + + sudo apt-get install golang-1.6 + +###Installing dependancies (standard) sudo apt-get update sudo apt-get --no-install-recommends install imagemagick libsodium-dev sox build-essential git ca-certificates -####Compiling and installing `ffmpeg` (`ffmpeg` is not available in Trisquel repos) +###Installing dependancies (`ffmpeg` is not available in Trisquel repos - there must be compiled) This will install `ffmpeg` to `/sur/local/bin/ffmpeg`: @@ -69,21 +73,15 @@ This will install `ffmpeg` to `/sur/local/bin/ffmpeg`: sudo make install rm -rf ffmpeg -###Install Go - -Run this to install Go. - - sudo apt-get install golang-1.6 - ###Installing Redis -Run this to install Redis. +Run this to install Redis - if you want to use Redis. sudo apt-get install redis-server ###Installing Postgres (WIP) -Run this to install Postgres. +Run this to install Postgres - if you want to use Postgres. sudo apt-get install Postgres From 1f2c644bf6e77db5da08de6ed03073dc730bc802 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:16:22 +0200 Subject: [PATCH 71/91] Update building.md --- doc/building.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/building.md b/doc/building.md index 0d4bd98..2b3082b 100644 --- a/doc/building.md +++ b/doc/building.md @@ -55,11 +55,11 @@ These are installation instructions for Trisquel. Run this to install Go. + sudo apt-get update sudo apt-get install golang-1.6 ###Installing dependancies (standard) - sudo apt-get update sudo apt-get --no-install-recommends install imagemagick libsodium-dev sox build-essential git ca-certificates ###Installing dependancies (`ffmpeg` is not available in Trisquel repos - there must be compiled) From 648b66cbbe32be84ae814a5f92dc9a76468a819e Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:17:28 +0200 Subject: [PATCH 72/91] Update building.md --- doc/building.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/building.md b/doc/building.md index 2b3082b..0fdee82 100644 --- a/doc/building.md +++ b/doc/building.md @@ -1,5 +1,5 @@ -Building the NNTPChan server -============================ +Building NNPTChan +================= This document will help you setup the NNTPChan server from the source code. From 76b6bad8a597593c6317a6a3d48c2d531ad8d516 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:18:58 +0200 Subject: [PATCH 73/91] Update building.md --- doc/building.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/building.md b/doc/building.md index 0fdee82..d762ce7 100644 --- a/doc/building.md +++ b/doc/building.md @@ -8,6 +8,7 @@ This document will help you setup the NNTPChan server from the source code. NNTPChan can run on the following operating systems: * Linux + * Instructions are available for Debian and Trisquel. * FreeBSD Dependancies: From 47b722a825054996824067362366b84bf392d78e Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:19:27 +0200 Subject: [PATCH 74/91] Update building.md --- doc/building.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/building.md b/doc/building.md index d762ce7..a0d1a18 100644 --- a/doc/building.md +++ b/doc/building.md @@ -1,7 +1,7 @@ Building NNPTChan ================= -This document will help you setup the NNTPChan server from the source code. +This document will help you build the NNTPChan software from the source code. ##Requirements From 89b51773eb568328fe3a91b73199e2517a0bf054 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:20:20 +0200 Subject: [PATCH 75/91] Update building.md --- doc/building.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/building.md b/doc/building.md index a0d1a18..1c7797a 100644 --- a/doc/building.md +++ b/doc/building.md @@ -65,7 +65,7 @@ Run this to install Go. ###Installing dependancies (`ffmpeg` is not available in Trisquel repos - there must be compiled) -This will install `ffmpeg` to `/sur/local/bin/ffmpeg`: +This will install `ffmpeg` to `/usr/local/bin/ffmpeg`: git clone https://git.ffmpeg.org/ffmpeg.git ffmpeg --depth=1 cd ffmpeg From 43dcbad33c5e1ec7397e05b71d440cd9f8e25e6b Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:21:48 +0200 Subject: [PATCH 76/91] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d79ca03..a850018 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ NNTPChan **NNTPChan** (previously known as overchan) is a decentralized imageboard that uses the [NNTP protocol](https://en.wikipedia.org/wiki/Network_News_Transfer_Protocol) (network-news protocol) to synchronize content between many different servers. It utilizes cryptographically signed posts to perform optional/opt-in decentralized moderation. -This repository contains resources used by the core daemon which is located on [github](https://github.com/majestrate/srndv2) (for now) along with general documentation, [here](doc/) +This repository contains resources used by the core daemon which is located on [GitHub](https://github.com/majestrate/srndv2) (for now) along with general documentation, [here](doc/) ##Getting started -[This](doc) is a step-by-step guide for getting up and running with NNTPChan. +[This](doc) is a step-by-step guide for getting up-and-running with NNTPChan as well as documentation for developers wwho want to either work on NNTPChan directly or use NNTPChan in their aplications with the API. ##Bugs and issues From 43a81a6a4d4ef06d74b9ecc59329c5b720079f9e Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:22:23 +0200 Subject: [PATCH 77/91] Delete database.md --- doc/.trash/database.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 doc/.trash/database.md diff --git a/doc/.trash/database.md b/doc/.trash/database.md deleted file mode 100644 index 13e0008..0000000 --- a/doc/.trash/database.md +++ /dev/null @@ -1,7 +0,0 @@ -You have 2 choices for database backend: - -* [postgres](postgres.md) - -* [redis](redis.md) - -NOTE: we don't need this file no more From 1eed2cdd1a618bba8364f349246e0e11449c8ec7 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:24:23 +0200 Subject: [PATCH 78/91] Update setting-up.md --- doc/setting-up.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index 2c63a5b..24d29c3 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -34,7 +34,7 @@ First your will be asked what data-storage system you would like to use. We supp ![Image 3](http://i.imgur.com/WPXedZB.png) -**First** [Install and Configure Postgres database](database/postgres/postgres.md). +**First** [Install and Configure Postgres database](database/postgres/install-and-configure-postgres.md). **Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your Postres server (I would run it locally on 127.0.0.1 to be safe). From 4ab24625faec9854d6fddbb37948b690c6c619da Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:25:33 +0200 Subject: [PATCH 79/91] Update building.md --- doc/building.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/building.md b/doc/building.md index 1c7797a..91b6334 100644 --- a/doc/building.md +++ b/doc/building.md @@ -33,6 +33,20 @@ Install the Go programming language version _1.6_ from the [Go website](https:// sudo apt-get update sudo apt-get --no-install-recommends install imagemagick libsodium-dev ffmpeg sox build-essential git ca-certificates +###Installing Redis + +Run this to install Redis - if you want to use Redis. + + su + apt-get install redis-server + +###Installing Postgres (WIP) + +Run this to install Postgres - if you want to use Postgres. + + su + apt-get install Postgres + ###Get the NNTPChan source git clone https://github.com/majestrate/nntpchan --depth=1 From 55baec7af7772d6fd91407d5ad66f3ad02a0b626 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:27:16 +0200 Subject: [PATCH 80/91] Update building.md --- doc/building.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/building.md b/doc/building.md index 91b6334..4efa5ee 100644 --- a/doc/building.md +++ b/doc/building.md @@ -45,7 +45,7 @@ Run this to install Redis - if you want to use Redis. Run this to install Postgres - if you want to use Postgres. su - apt-get install Postgres + apt-get install --no-install-recommends postgresql postgresql-client ###Get the NNTPChan source From e50099b7c04230155b67c9aaffbd2f71ae49bdfd Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:28:08 +0200 Subject: [PATCH 81/91] Update building.md --- doc/building.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/building.md b/doc/building.md index 4efa5ee..a9ccd32 100644 --- a/doc/building.md +++ b/doc/building.md @@ -44,6 +44,7 @@ Run this to install Redis - if you want to use Redis. Run this to install Postgres - if you want to use Postgres. + # install as root su apt-get install --no-install-recommends postgresql postgresql-client From 9e3e597088e6d6aa64369e81c6ee55cd48ea7daf Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:28:44 +0200 Subject: [PATCH 82/91] Update building.md --- doc/building.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/building.md b/doc/building.md index a9ccd32..b5e7f62 100644 --- a/doc/building.md +++ b/doc/building.md @@ -63,7 +63,7 @@ If you want to build without support for Redis then build with the `--no-redis` ./build.sh --no-redis -##Trisquel instructions +##Trisquel instructions (WIP) These are installation instructions for Trisquel. @@ -99,7 +99,7 @@ Run this to install Redis - if you want to use Redis. Run this to install Postgres - if you want to use Postgres. - sudo apt-get install Postgres + sudo apt-get install --no-install-recommends postgresql postgresql-client ###Get the NNTPChan source From dbb119bd8b02165d857e504406e1c9966fc58d7c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:29:23 +0200 Subject: [PATCH 83/91] Create Configuring Postgres database --- doc/.trash/Configuring Postgres database | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 doc/.trash/Configuring Postgres database diff --git a/doc/.trash/Configuring Postgres database b/doc/.trash/Configuring Postgres database new file mode 100644 index 0000000..aaafbc5 --- /dev/null +++ b/doc/.trash/Configuring Postgres database @@ -0,0 +1,6 @@ +##Installing Postgres + +Postgres on Debian (as root) + + # install as root + apt-get install --no-install-recommends postgresql postgresql-client From 42ef4c4df145cf6af1e4e2f0fa31f2b97d6959cf Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:29:43 +0200 Subject: [PATCH 84/91] Update install-and-configure-postgres.md --- doc/database/postgres/install-and-configure-postgres.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/doc/database/postgres/install-and-configure-postgres.md b/doc/database/postgres/install-and-configure-postgres.md index 75d98c9..5f519c1 100644 --- a/doc/database/postgres/install-and-configure-postgres.md +++ b/doc/database/postgres/install-and-configure-postgres.md @@ -3,13 +3,6 @@ Configuring Postgres database These are instructions for setting up NNTPChan with Postgres as the data-storage system. -##Installing Postgres - -Postgres on Debian (as root) - - # install as root - apt-get install --no-install-recommends postgresql postgresql-client - ##Configuring Postgres Setting up postgres (as root) From e9592b60210f670594d10dd560013a059e3984fc Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:30:24 +0200 Subject: [PATCH 85/91] Create Configuring Redis database --- doc/.trash/Configuring Redis database | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 doc/.trash/Configuring Redis database diff --git a/doc/.trash/Configuring Redis database b/doc/.trash/Configuring Redis database new file mode 100644 index 0000000..b703bad --- /dev/null +++ b/doc/.trash/Configuring Redis database @@ -0,0 +1,5 @@ +##Installing Redis + +Redis 3.x or higher is required, [stable release](http://download.redis.io/releases/redis-stable.tar.gz) recommended + +* See http://redis.io/download From 588e19e93cac5ac7bec90ba39e91319db2d30d89 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:30:26 +0200 Subject: [PATCH 86/91] Update install-and-configure-redis.md --- doc/database/redis/install-and-configure-redis.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/doc/database/redis/install-and-configure-redis.md b/doc/database/redis/install-and-configure-redis.md index 3b635ae..6dd67a4 100644 --- a/doc/database/redis/install-and-configure-redis.md +++ b/doc/database/redis/install-and-configure-redis.md @@ -3,12 +3,6 @@ Configuring Redis database These are instructions for setting up NNTPChan with Redis as the data-storage system. -##Installing Redis - -Redis 3.x or higher is required, [stable release](http://download.redis.io/releases/redis-stable.tar.gz) recommended - -* See http://redis.io/download - ##Configuring Redis In `srnd.ini` the database sections should look like this: From 00153e3957d528c99ee7d3ccb0f842b28b1e817c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:30:58 +0200 Subject: [PATCH 87/91] Rename install-and-configure-redis.md to configure-redis.md --- .../redis/{install-and-configure-redis.md => configure-redis.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/database/redis/{install-and-configure-redis.md => configure-redis.md} (100%) diff --git a/doc/database/redis/install-and-configure-redis.md b/doc/database/redis/configure-redis.md similarity index 100% rename from doc/database/redis/install-and-configure-redis.md rename to doc/database/redis/configure-redis.md From b9373e44a1c4042a626bb1fe48bb99459e2625d4 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:31:46 +0200 Subject: [PATCH 88/91] Update setting-up.md --- doc/setting-up.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/setting-up.md b/doc/setting-up.md index 24d29c3..4c4127a 100644 --- a/doc/setting-up.md +++ b/doc/setting-up.md @@ -21,7 +21,7 @@ First your will be asked what data-storage system you would like to use. We supp ![Image 2](http://i.imgur.com/HDp4Ddf.png) -**First** [Install and Configure Redis database](database/redis/install-and-configure-redis.md). +**First** [Install and Configure Redis database](database/redis/configure-redis.md). **Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your Redis server (I would run it locally on 127.0.0.1 to be safe). @@ -34,7 +34,7 @@ First your will be asked what data-storage system you would like to use. We supp ![Image 3](http://i.imgur.com/WPXedZB.png) -**First** [Install and Configure Postgres database](database/postgres/install-and-configure-postgres.md). +**First** [Install and Configure Postgres database](database/postgres/configure-postgres.md). **Then** fill in the fields below: * **Hostname or IP Address** - This is the hostname or IP address of your Postres server (I would run it locally on 127.0.0.1 to be safe). @@ -80,7 +80,7 @@ NNTPChan needs to know the paths to the listed programs on your system. Check out the following in order: 1. Setting up data-storage system (choose i or ii) - 1. [Setting up using Postgres](database/postgres/install-and-configure-postgres.md) - 2. [Setting up using Redis](database/redis/install-and-configure-redis.md) + 1. [Setting up using Postgres](database/postgres/configure-postgres.md) + 2. [Setting up using Redis](database/redis/configure-redis.md) 2. [Setting up NNTPChan system](srnd.md) 3. [Setting up feeds](feeds.md) From 435bfa17d583ff99b0b12f96d80c2b4dfa358c91 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:32:04 +0200 Subject: [PATCH 89/91] Rename install-and-configure-postgres.md to configure-postgres.md --- .../{install-and-configure-postgres.md => configure-postgres.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/database/postgres/{install-and-configure-postgres.md => configure-postgres.md} (100%) diff --git a/doc/database/postgres/install-and-configure-postgres.md b/doc/database/postgres/configure-postgres.md similarity index 100% rename from doc/database/postgres/install-and-configure-postgres.md rename to doc/database/postgres/configure-postgres.md From 67cd4ab112723c16b44e76746788025af7f18a95 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:37:22 +0200 Subject: [PATCH 90/91] Update configure-postgres.md --- doc/database/postgres/configure-postgres.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/database/postgres/configure-postgres.md b/doc/database/postgres/configure-postgres.md index 5f519c1..c870c6a 100644 --- a/doc/database/postgres/configure-postgres.md +++ b/doc/database/postgres/configure-postgres.md @@ -5,7 +5,7 @@ These are instructions for setting up NNTPChan with Postgres as the data-storage ##Configuring Postgres -Setting up postgres (as root) +Setting up postgres (as root): # become postgres user su postgres From 9728cf697b94cb8a462d99e07427bb632b63b643 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sun, 5 Jun 2016 13:59:18 +0200 Subject: [PATCH 91/91] Update .gitignore --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index eb66e38..562c145 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,6 @@ vendor # generated js contrib/static/nntpchan.js contrib/static/miner-js.js + +#docs trash +doc/.trash