From 52239bebc34c3a5955054c314cc0d8baa7ea8762 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:08:25 +0200 Subject: [PATCH 01/42] Update README.md --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 186fcb3..ddaeb99 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ -# NNTPChan # +NNTPChan +======== -NNTPChan (previously known as overchan) is a decentralized imageboard that uses nntp to synchronize content between many different servers. It utilizes cryptographically signed posts to perform optional/opt-in decentralized moderation. +**NNTPChan** (previously known as overchan) is a decentralized imageboard that uses the NNTP 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/) -## getting started ## +##Getting started - -[see build documentation](doc/build.md) +Before you can begin configuring your NNTPChan node you will have to compile the source code. For instructions read the [Building NNTPChan](doc/build.md) document. +[see build documentation]() --- From b41d2fa532eb88d2eb49cab965643a5d78a5c03d Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:08:46 +0200 Subject: [PATCH 02/42] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index ddaeb99..1fda984 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ This repository contains resources used by the core daemon which is located on [ ##Getting started Before you can begin configuring your NNTPChan node you will have to compile the source code. For instructions read the [Building NNTPChan](doc/build.md) document. -[see build documentation]() --- From 0d5b0ddb0b68084e3f9f85c8c4cc0f2f7578a193 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:09:35 +0200 Subject: [PATCH 03/42] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1fda984..99996f3 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,10 @@ This repository contains resources used by the core daemon which is located on [ ##Getting started -Before you can begin configuring your NNTPChan node you will have to compile the source code. For instructions read the [Building NNTPChan](doc/build.md) document. +This is a step=by-step guide for getting up and running with NNTPChan. + +1. [Compile the source code](doc/build.md) +2. --- From 7612b629adf03e0389fea9dc0191a0c685c4495a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:11:06 +0200 Subject: [PATCH 04/42] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99996f3..170aea3 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ 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. +This is a step-by-step guide for getting up and running with NNTPChan. -1. [Compile the source code](doc/build.md) +1. [Compile the NNTPChan server](doc/build.md) 2. --- From 4f204fd87302380aa4ead439f61c0b98b803e131 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:16:08 +0200 Subject: [PATCH 05/42] Update build.md --- doc/build.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/build.md b/doc/build.md index 7800c9e..61fc624 100644 --- a/doc/build.md +++ b/doc/build.md @@ -1,19 +1,21 @@ -# building the daemon # +Bulllding the NNTPChan server +============================= +##Requirements -## requirements ## +NNTPChan can run on the following operating systems: -* linux or freebsd -* libsodium 1.0 or higher +* Linux +* FreeBSD + +Dependancies: + +* libsodium _1.0_ or _higher_ * imagemagick * ffmpeg * sox - -## supported go versions ## - -* `go 1.6` or higher with redis driver - -* `go 1.3` or higher without redis driver +* go _1.6_ or _higher_ **with redis driver** +* go _1.3_ or _higher_ **without redis driver** ## debian ## From 89c4fe4a963f3dd6550d9c1753732d457b45e91a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:16:55 +0200 Subject: [PATCH 06/42] Update build.md --- doc/build.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/build.md b/doc/build.md index 61fc624..651b7cd 100644 --- a/doc/build.md +++ b/doc/build.md @@ -1,5 +1,7 @@ -Bulllding the NNTPChan server -============================= +Building the NNTPChan server +============================ + +This document will help you setup the NNTPChan server. ##Requirements From 27eae6750ca8b4d0d82496bef03487cdba048a1a Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:18:03 +0200 Subject: [PATCH 08/42] Update build.md --- doc/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/build.md b/doc/build.md index 651b7cd..a0d60a9 100644 --- a/doc/build.md +++ b/doc/build.md @@ -1,7 +1,7 @@ Building the NNTPChan server ============================ -This document will help you setup the NNTPChan server. +This document will help you setup the NNTPChan server fsource code.rom the ##Requirements From aa04d1d3baea94b697c4033c75d8cfa99abbe927 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:18:14 +0200 Subject: [PATCH 09/42] Update build.md --- doc/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/build.md b/doc/build.md index a0d60a9..b4f3a86 100644 --- a/doc/build.md +++ b/doc/build.md @@ -1,7 +1,7 @@ Building the NNTPChan server ============================ -This document will help you setup the NNTPChan server fsource code.rom the +This document will help you setup the NNTPChan server from the source code. ##Requirements From 546f4d413f12e4605fb10be778b0b9df6d419d9c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:26:36 +0200 Subject: [PATCH 10/42] Create securing-redis.md --- doc/securing-redis.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 doc/securing-redis.md diff --git a/doc/securing-redis.md b/doc/securing-redis.md new file mode 100644 index 0000000..09d8064 --- /dev/null +++ b/doc/securing-redis.md @@ -0,0 +1,15 @@ +Securing Redis +============== + +This document provides a good tip for securing your Redis server, just to be 100% happy with the security. + +##Adding an authentication password for commands + +This will allow you to add a password to your Redis server that must be used before any other commands can be issued to your Redis server. + +* Remember choose a strong password with lower-case, upper-case, numbers and other symbols. +* Make sure there are no spaces. (need to still test this #6969) + +Then take your password, `x` and run this command (with `sudo` if needed). + + echo "x" > /path/to/your/redis.conf From 8e1eb8620c1d82282ddb0e0917dd107ddf9f3902 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:27:39 +0200 Subject: [PATCH 11/42] Update build.md --- doc/build.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/doc/build.md b/doc/build.md index b4f3a86..e74eb10 100644 --- a/doc/build.md +++ b/doc/build.md @@ -19,23 +19,29 @@ Dependancies: * go _1.6_ or _higher_ **with redis driver** * go _1.3_ or _higher_ **without redis driver** -## debian ## +##Debian instructions -Get `go 1.6` from [here](https://golang.org/dl/) for your platform +###Install Go -Get the dependancies +Install the Go programming language version _1.6_ from the [Go website](https://golang.org/dl/). + +###Install the dependancies sudo apt-get update sudo apt-get --no-install-recommends install imagemagick libsodium-dev ffmpeg sox build-essential git ca-certificates +###Get the NNTPChan source -Check out the repo and build it - - git clone https://github.com/majestrate/nntpchan + 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 supporting redis then build with the `--no-redis` flag +If you want to build without support for Redis then build with the `--no-redis` flag ./build.sh --no-redis From 7a73cf3d554ec980d10e3d1d3c61935efa4ca577 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:28:24 +0200 Subject: [PATCH 12/42] Update build.md --- doc/build.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/build.md b/doc/build.md index e74eb10..b1ec3ff 100644 --- a/doc/build.md +++ b/doc/build.md @@ -21,6 +21,8 @@ Dependancies: ##Debian instructions +These are instalaltion instructions for Debian. + ###Install Go Install the Go programming language version _1.6_ from the [Go website](https://golang.org/dl/). From 030a9e58e846f682ff93fa64674bec74c630f742 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:31:24 +0200 Subject: [PATCH 13/42] Update build.md --- doc/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/build.md b/doc/build.md index b1ec3ff..62bfa9b 100644 --- a/doc/build.md +++ b/doc/build.md @@ -21,7 +21,7 @@ Dependancies: ##Debian instructions -These are instalaltion instructions for Debian. +These are installation instructions for Debian. ###Install Go From dfe6eae59f59f33a1f1c7994e5df11d148a8a44b Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:32:57 +0200 Subject: [PATCH 14/42] Update build.md --- doc/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/build.md b/doc/build.md index 62bfa9b..9ea25ec 100644 --- a/doc/build.md +++ b/doc/build.md @@ -43,7 +43,7 @@ If you want to compile with Redis support (recommended - Redis is easy to use) t ./build.sh -If you want to build without support for Redis then build with the `--no-redis` flag +If you want to build without support for Redis then build with the `--no-redis` flag: ./build.sh --no-redis From 5087a0de7af61346f36e6e9c4c48338060ae9b0e Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:34:43 +0200 Subject: [PATCH 15/42] Update build.md --- doc/build.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/build.md b/doc/build.md index 9ea25ec..74b456e 100644 --- a/doc/build.md +++ b/doc/build.md @@ -47,4 +47,6 @@ If you want to build without support for Redis then build with the `--no-redis` ./build.sh --no-redis -To run eiter run `./srndv2 setup` and browse to http://127.0.0.1:18000 or configure [by hand](database.md) +##Now let's setup NNTPChan + +Check out [Configuring NNTPChan](doc/config.md). From 8492cc35fa79647d929bbf346f6ceb1719ebe45c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:35:00 +0200 Subject: [PATCH 16/42] Update build.md --- doc/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/build.md b/doc/build.md index 74b456e..ec76253 100644 --- a/doc/build.md +++ b/doc/build.md @@ -49,4 +49,4 @@ If you want to build without support for Redis then build with the `--no-redis` ##Now let's setup NNTPChan -Check out [Configuring NNTPChan](doc/config.md). +Check out [Configuring NNTPChan](config.md). From 90aaad39bf10c575abc8723f280fafcaf3f20431 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:36:26 +0200 Subject: [PATCH 17/42] Create config.md --- doc/config.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 doc/config.md diff --git a/doc/config.md b/doc/config.md new file mode 100644 index 0000000..9cf6461 --- /dev/null +++ b/doc/config.md @@ -0,0 +1,8 @@ +Configuring NNTPChan server +=========================== + +This document provides a step-by-step guide to configurin your NNTPChan node. + +##Configuring via web-interface + +You can configure NNTPChan via the web-interface by navigating your browser to http://127.0.0.1:18000. From 93434f3bf6ba64adde79031c31639d91744beb15 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:39:34 +0200 Subject: [PATCH 18/42] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 170aea3..800c372 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ This repository contains resources used by the core daemon which is located on [ This is a step-by-step guide for getting up and running with NNTPChan. 1. [Compile the NNTPChan server](doc/build.md) -2. +2. [Configuring your NNTPChan node](doc/config.md) ---- +##Bugs and issues -*PLEASE* report any bugs you find while setting up or building on [github](https://github.com/majestrate/nntpchan/issues) or [gitgud](https://gitgud.io/uguu/nntpchan/issues) so that the problems get fixed :\^) +*PLEASE* report any bugs you find while building, setting-up or using NNTPChan on the [GitHub issue tracker](https://github.com/majestrate/nntpchan/issues) or on the [GitGud issue tracker](https://gitgud.io/uguu/nntpchan/issues) so that the probelms can be resolved or discussed. IRC: From f06daf111a85c3c782251118aa166c4cb4c9443c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:40:09 +0200 Subject: [PATCH 19/42] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 800c372..85cc714 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ NNTPChan ======== -**NNTPChan** (previously known as overchan) is a decentralized imageboard that uses the NNTP protocol (network-news protocol) to synchronize content between many different servers. It utilizes cryptographically signed posts to perform optional/opt-in decentralized moderation. +**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/) From 71bb46cb5b9852c4ca5c09334db0d702a20492f2 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:40:16 +0200 Subject: [PATCH 20/42] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 85cc714..6e32034 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ 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. +**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/) From 4436c62fe21d39f6a14354f9e5e9018da24f6f60 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:43:05 +0200 Subject: [PATCH 21/42] Update config.md --- doc/config.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/config.md b/doc/config.md index 9cf6461..154a944 100644 --- a/doc/config.md +++ b/doc/config.md @@ -6,3 +6,10 @@ This document provides a step-by-step guide to configurin your NNTPChan node. ##Configuring via web-interface You can configure NNTPChan via the web-interface by navigating your browser to http://127.0.0.1:18000. + +###Selecting yoru data-storage system + +[Image 1]() + +First your will be asked what data-storage system you would like to use. We support Redis and PostgreSQL. + From c5937bc3f7c381aa94201b4d4b2bc08e1552efd7 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:44:10 +0200 Subject: [PATCH 22/42] Update config.md --- doc/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index 154a944..950de51 100644 --- a/doc/config.md +++ b/doc/config.md @@ -9,7 +9,7 @@ You can configure NNTPChan via the web-interface by navigating your browser to h ###Selecting yoru data-storage system -[Image 1]() +[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. From bf143f07f7ca699c08b4faa3d5188307e2100fb9 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:45:22 +0200 Subject: [PATCH 24/42] Update config.md --- doc/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index 950de51..c022bb5 100644 --- a/doc/config.md +++ b/doc/config.md @@ -9,7 +9,7 @@ You can configure NNTPChan via the web-interface by navigating your browser to h ###Selecting yoru data-storage system -[Image 1](http://i.imgur.com/l9iiXxB.png) +![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. From ca2d87e303bf6aa6705a7eb23eafaf429f8b7092 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:50:02 +0200 Subject: [PATCH 25/42] Update config.md --- doc/config.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/config.md b/doc/config.md index c022bb5..f5c11b0 100644 --- a/doc/config.md +++ b/doc/config.md @@ -13,3 +13,12 @@ You can configure NNTPChan via the web-interface by navigating your browser to h First your will be asked what data-storage system you would like to use. We support Redis and PostgreSQL. +###Redis configuration + +![http://i.imgur.com/HDp4Ddf.png]() + +If you have chosen Redis 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 to be safe). +* **Port** - The port that your Redis server is running on. +* **Password** - Optional authentication password for Redis ([Setting up a Redis password](securing-redis.md)). From a75c22aecb103bd9fb809f43248ff9df06475a2d Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:50:46 +0200 Subject: [PATCH 26/42] Update config.md --- doc/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index f5c11b0..e5e03df 100644 --- a/doc/config.md +++ b/doc/config.md @@ -15,7 +15,7 @@ First your will be asked what data-storage system you would like to use. We supp ###Redis configuration -![http://i.imgur.com/HDp4Ddf.png]() +![Image 2](http://i.imgur.com/HDp4Ddf.png) If you have chosen Redis then fill in the fields below: From 963b893e39378f649b1e513758c868659c1ef184 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:51:07 +0200 Subject: [PATCH 27/42] Update config.md --- doc/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index e5e03df..895ce3f 100644 --- a/doc/config.md +++ b/doc/config.md @@ -13,7 +13,7 @@ You can configure NNTPChan via the web-interface by navigating your browser to h First your will be asked what data-storage system you would like to use. We support Redis and PostgreSQL. -###Redis configuration +####Redis configuration ![Image 2](http://i.imgur.com/HDp4Ddf.png) From cfeb11b545d4e024c5ed1679d309609ccdb686d4 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:51:21 +0200 Subject: [PATCH 28/42] Update config.md --- doc/config.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/config.md b/doc/config.md index 895ce3f..9ca6fcd 100644 --- a/doc/config.md +++ b/doc/config.md @@ -13,6 +13,8 @@ You can configure NNTPChan via the web-interface by navigating your browser to h First your will be asked what data-storage system you would like to use. We support Redis and PostgreSQL. +
+ ####Redis configuration ![Image 2](http://i.imgur.com/HDp4Ddf.png) From a85340923084f89c7ac7ef5bd0d74add169431b6 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:55:01 +0200 Subject: [PATCH 29/42] Update config.md --- doc/config.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/doc/config.md b/doc/config.md index 9ca6fcd..d5a648e 100644 --- a/doc/config.md +++ b/doc/config.md @@ -21,6 +21,20 @@ First your will be asked what data-storage system you would like to use. We supp If you have chosen Redis 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 to be safe). -* **Port** - The port that your Redis server is running on. +* **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)). + +
+ +####PostgreSQL configuration + +![]() + +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. +* **Username** - The username for PostgreSQL. +* **Password** - The password for PostgreSQL. +* **** - From 6ce938b86a9b6f177002cd5568a776c4643d3dab Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:55:50 +0200 Subject: [PATCH 30/42] Update config.md --- doc/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index d5a648e..873b6c8 100644 --- a/doc/config.md +++ b/doc/config.md @@ -29,7 +29,7 @@ If you have chosen Redis then fill in the fields below: ####PostgreSQL configuration -![]() +![http://i.imgur.com/WPXedZB.png]() If you have chosen PostgreSQL then fill in the fields below: From 1fb23dd34a393efa815c7f39286e647a10f49a23 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:56:17 +0200 Subject: [PATCH 31/42] Update config.md --- doc/config.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/config.md b/doc/config.md index 873b6c8..2f6c7f5 100644 --- a/doc/config.md +++ b/doc/config.md @@ -29,7 +29,7 @@ If you have chosen Redis then fill in the fields below: ####PostgreSQL configuration -![http://i.imgur.com/WPXedZB.png]() +![Image 3](http://i.imgur.com/WPXedZB.png) If you have chosen PostgreSQL then fill in the fields below: @@ -37,4 +37,3 @@ If you have chosen PostgreSQL then fill in the fields below: * **Port number** - This is the port that your PostgreSQL server is running on. * **Username** - The username for PostgreSQL. * **Password** - The password for PostgreSQL. -* **** - From 18ea50ab18c7c4a5147cb0d7362e336de2435e6d Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 17:59:54 +0200 Subject: [PATCH 32/42] Update config.md --- doc/config.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/config.md b/doc/config.md index 2f6c7f5..26167cb 100644 --- a/doc/config.md +++ b/doc/config.md @@ -37,3 +37,12 @@ If you have chosen PostgreSQL then fill in the fields below: * **Port number** - This is the port that your PostgreSQL server is running on. * **Username** - The username for PostgreSQL. * **Password** - The password for PostgreSQL. + +
+ +###Configuring the NNTP server + +* **Name of NNTP instance** - What is the significamce of this name. +* **Allow attachements** - Check the box if you want people to be able to add attachements to posts. +* **Allow anonymous posters** - Check the box if you want to allow anonymous posters. +* **Allow attachments from anonymous posters** - Check the box if you want to allow anonymous posters to add attachments to their posts, From 89dee3b72d24258080d25a82bbe15247343abd2c Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 18:00:27 +0200 Subject: [PATCH 33/42] Update config.md --- doc/config.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index 26167cb..fade9cc 100644 --- a/doc/config.md +++ b/doc/config.md @@ -45,4 +45,5 @@ If you have chosen PostgreSQL then fill in the fields below: * **Name of NNTP instance** - What is the significamce of this name. * **Allow attachements** - Check the box if you want people to be able to add attachements to posts. * **Allow anonymous posters** - Check the box if you want to allow anonymous posters. -* **Allow attachments from anonymous posters** - Check the box if you want to allow anonymous posters to add attachments to their posts, +* **Allow attachments from anonymous posters** - Check the box if you want to allow anonymous posters to add attachments to their posts. +* **Require TLS for incoming connections** - Check the box if NNTP connections must be encrypted and authenticated with TLS (highly recommended). From b9905ebae4feb07aff42da285867eab0e4364270 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 18:01:40 +0200 Subject: [PATCH 34/42] Update config.md --- doc/config.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index fade9cc..039e400 100644 --- a/doc/config.md +++ b/doc/config.md @@ -7,7 +7,7 @@ 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 yoru data-storage system +###Selecting your data-storage system ![Image 1](http://i.imgur.com/l9iiXxB.png) @@ -42,6 +42,10 @@ If you have chosen PostgreSQL then fill in the fields below: ###Configuring the NNTP server +![Image 4](http://i.imgur.com/FXxShtu.png) + +Fill in the fields required for the NNTP server. + * **Name of NNTP instance** - What is the significamce of this name. * **Allow attachements** - Check the box if you want people to be able to add attachements to posts. * **Allow anonymous posters** - Check the box if you want to allow anonymous posters. From e143a78e20c0e86dda2f4880ec3151d046346a2f Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 18:04:17 +0200 Subject: [PATCH 35/42] Update config.md --- doc/config.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/config.md b/doc/config.md index 039e400..4f8e895 100644 --- a/doc/config.md +++ b/doc/config.md @@ -51,3 +51,12 @@ Fill in the fields required for the NNTP server. * **Allow anonymous posters** - Check the box if you want to allow anonymous posters. * **Allow attachments from anonymous posters** - Check the box if you want to allow anonymous posters to add attachments to their posts. * **Require TLS for incoming connections** - Check the box if NNTP connections must be encrypted and authenticated with TLS (highly recommended). + +###Configuring TLS + +![Image 5](http://i.imgur.com/EjkrjTT.png) + +Fill in the fields required for the TLS security system. + +* **Hostname or IP address** - FIXME. +* **TLS keyname** - FIXME. From 285f5c271ac01645624f7f051823a886ddcacfba Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 18:07:40 +0200 Subject: [PATCH 36/42] Update config.md --- doc/config.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/config.md b/doc/config.md index 4f8e895..7b717da 100644 --- a/doc/config.md +++ b/doc/config.md @@ -60,3 +60,13 @@ Fill in the fields required for the TLS security system. * **Hostname or IP address** - FIXME. * **TLS keyname** - FIXME. + +###Set paths to external programs + +![Image 6](http://i.imgur.com/hBXYJDo.png) + +NNTPChan needs to know the paths to the listed programs on your system. + +* **convert path** - Path to the `convert` program. +* **ffmpeg path** - Path to the `ffmpeg` program. +* **sox path** - Path to the `sox` program. From 28b8c5059c159a1a1fce8be2105684cff0ccbcc2 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 18:57:21 +0200 Subject: [PATCH 37/42] Update securing-redis.md --- doc/securing-redis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/securing-redis.md b/doc/securing-redis.md index 09d8064..5983166 100644 --- a/doc/securing-redis.md +++ b/doc/securing-redis.md @@ -12,4 +12,4 @@ This will allow you to add a password to your Redis server that must be used bef Then take your password, `x` and run this command (with `sudo` if needed). - echo "x" > /path/to/your/redis.conf + echo "requirepass x" >> /path/to/your/redis.conf From 77e1f16624a488fca74d08a0fc1ca922e2db6ed3 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 19:24:12 +0200 Subject: [PATCH 38/42] Update cli.md --- doc/cli.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/doc/cli.md b/doc/cli.md index a71a59d..7825bfc 100644 --- a/doc/cli.md +++ b/doc/cli.md @@ -1,20 +1,37 @@ -# command line interface +#Command-line interface + +**srndv2** comes with a selection of command-line arguments for managing your node. + +##Rebuild all thumbnails + +To rebuild all thumbnails run: - # rebuild all thumbnails srndv2 tool rethumb - # generate a new tripcode keypair - # print out to stdout +##Generate a new tripcode keypair (prints to stdout) + srndv2 tool keygen - # add an nntp login +##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 - - # remove an nntp login + +##Remove an existing NNTP user + +Where `username` is the username of the user to be deleted. + srndv2 tool nntp del-login username - # add public key to moderation trust - srndv2 tool mod add publickeygoeshere +##Add a public key to moderation trust + +Where `publickey` is the public key to be added. + + srndv2 tool mod add publickey - # remove public key from moderation trust - srndv2 tool mod del publickeygoeshere +##Remove a public key from moderation trust + +Where `publickey` is the public key to be removed. + + srndv2 tool mod del publickey From 5337fea89f18a3c1ba8de782b2f041106b68fc57 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 19:25:06 +0200 Subject: [PATCH 39/42] Update cli.md --- doc/cli.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/cli.md b/doc/cli.md index 7825bfc..13b85a7 100644 --- a/doc/cli.md +++ b/doc/cli.md @@ -2,6 +2,8 @@ **srndv2** comes with a selection of command-line arguments for managing your node. +[TOC] + ##Rebuild all thumbnails To rebuild all thumbnails run: From 37494455312dcdf405644625b61c89ae92cf2b13 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Sat, 4 Jun 2016 19:25:22 +0200 Subject: [PATCH 40/42] Update cli.md --- doc/cli.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/cli.md b/doc/cli.md index 13b85a7..7825bfc 100644 --- a/doc/cli.md +++ b/doc/cli.md @@ -2,8 +2,6 @@ **srndv2** comes with a selection of command-line arguments for managing your node. -[TOC] - ##Rebuild all thumbnails To rebuild all thumbnails run: From 3bd9e85682e788946329b7ece9a9f5ab82807837 Mon Sep 17 00:00:00 2001 From: d Date: Sat, 4 Jun 2016 19:37:04 +0200 Subject: [PATCH 41/42] : --- doc/cli.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/cli.md b/doc/cli.md index 7825bfc..5c4ea32 100644 --- a/doc/cli.md +++ b/doc/cli.md @@ -11,19 +11,7 @@ To rebuild all thumbnails run: ##Generate a new tripcode keypair (prints to stdout) srndv2 tool keygen - -##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 - -##Remove an existing NNTP user - -Where `username` is the username of the user to be deleted. - - srndv2 tool nntp del-login username - ##Add a public key to moderation trust Where `publickey` is the public key to be added. @@ -35,3 +23,15 @@ Where `publickey` is the public key to be added. Where `publickey` is the public key to be removed. 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 + +##Remove an existing NNTP user + +Where `username` is the username of the user to be deleted. + + srndv2 tool nntp del-login username From 59a8e244a03085b564e1e17c9883015a093d9c0a Mon Sep 17 00:00:00 2001 From: d Date: Sat, 4 Jun 2016 19:41:26 +0200 Subject: [PATCH 42/42] Nicer ending message. --- build.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/build.sh b/build.sh index ff2181c..090b3c5 100755 --- a/build.sh +++ b/build.sh @@ -88,4 +88,5 @@ else cp $GOPATH/bin/srndv2 $root fi -echo "Built" +echo -e "Built\n" +echo "Now configure NNTPChan with ./srndv2 setup"