Archived
1
0

update docs

This commit is contained in:
Jeff Becker 2017-04-04 09:01:43 -04:00
parent 08aaac492e
commit fa66537f9e
13 changed files with 145 additions and 221 deletions

View File

@ -20,8 +20,8 @@ Download the golang tarball, extract it to `/usr/local`, and add it to the globa
``` ```
cd /opt cd /opt
wget https://storage.googleapis.com/golang/go1.7.3.linux-amd64.tar.gz wget https://storage.googleapis.com/golang/go1.8.linux-amd64.tar.gz
tar -C /usr/local/ -xvzf go1.7.3.linux-amd64.tar.gz tar -C /usr/local/ -xvzf go1.8.linux-amd64.tar.gz
echo 'export PATH="$PATH:/usr/local/go/bin"' >> /etc/profile echo 'export PATH="$PATH:/usr/local/go/bin"' >> /etc/profile
``` ```
@ -33,7 +33,7 @@ Your `PATH` is set at login, so log out and back in before proceeding.
cd /opt cd /opt
git clone https://github.com/majestrate/nntpchan.git git clone https://github.com/majestrate/nntpchan.git
cd nntpchan cd nntpchan
./build.sh make
``` ```
Now you can proceed with [setting up NNTPChan](setting-up.md). When you get to the "set paths to external programs" step, you should change the ffmpeg path to `/usr/bin/avconv`. Now you can proceed with [setting up NNTPChan](setting-up.md). When you get to the "set paths to external programs" step, you should change the ffmpeg path to `/usr/bin/avconv`.

View File

@ -13,4 +13,4 @@ Install nntpchan:
# cd /opt # cd /opt
# git clone https://github.com/majestrate/nntpchan.git # git clone https://github.com/majestrate/nntpchan.git
# cd nntpchan # cd nntpchan
# ./build.sh # make

View File

@ -17,8 +17,8 @@ Dependancies:
* imagemagick * imagemagick
* ffmpeg * ffmpeg
* sox * sox
* go _1.6_ or _higher_ **with redis driver** * go _1.6_ or higher
* go _1.3_ or _higher_ **without redis driver** * GNU make
## Debian instructions ## Debian instructions
@ -31,22 +31,7 @@ Install the Go programming language version _1.6_ from the [Go website](https://
### Install the dependancies ### Install the dependancies
sudo apt-get update sudo apt-get update
sudo apt-get --no-install-recommends install imagemagick libsodium-dev ffmpeg sox build-essential git ca-certificates sudo apt-get --no-install-recommends install imagemagick libsodium-dev ffmpeg sox build-essential git ca-certificates postgresql postgresql-client
###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.
# install as root
su
apt-get install --no-install-recommends postgresql postgresql-client
### Get the NNTPChan source ### Get the NNTPChan source
@ -55,13 +40,10 @@ Run this to install Postgres - if you want to use Postgres.
### Now compile! ### Now compile!
If you want to compile with Redis support (recommended - Redis is easy to use) then run: Run `make`:
./build.sh make
If you want to build without support for Redis then build with the `--no-redis` flag:
./build.sh --no-redis
## Trisquel instructions (WIP) ## Trisquel instructions (WIP)
@ -76,7 +58,7 @@ Run this to install Go.
### Installing dependancies (standard) ### Installing dependancies (standard)
sudo apt-get --no-install-recommends install imagemagick libsodium-dev sox build-essential git ca-certificates sudo apt-get --no-install-recommends install imagemagick libsodium-dev sox build-essential git ca-certificates postgresql postgresql-client
### Installing dependancies (`ffmpeg` is not available in Trisquel repos - there must be compiled) ### Installing dependancies (`ffmpeg` is not available in Trisquel repos - there must be compiled)
@ -90,18 +72,6 @@ This will install `ffmpeg` to `/usr/local/bin/ffmpeg`:
cd .. cd ..
rm -rf ffmpeg rm -rf ffmpeg
###Installing 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 - if you want to use Postgres.
sudo apt-get install --no-install-recommends postgresql postgresql-client
### Get the NNTPChan source ### Get the NNTPChan source
git clone https://github.com/majestrate/nntpchan --depth=1 git clone https://github.com/majestrate/nntpchan --depth=1
@ -109,10 +79,6 @@ Run this to install Postgres - if you want to use Postgres.
### Now compile! ### Now compile!
If you want to compile with Redis support (recommended - Redis is easy to use) then run: run `make`
./build.sh make
If you want to build without support for Redis then build with the `--no-redis` flag:
./build.sh --no-redis

View File

@ -35,3 +35,9 @@ Where `username` is the username and `password` is the user's password for the n
Where `username` is the username of the user to be deleted. Where `username` is the username of the user to be deleted.
./srndv2 tool nntp del-login username ./srndv2 tool nntp del-login username
## Moderator shell
commandline interface for moderator actions
./srndv2 tool mod do

View File

@ -1,20 +0,0 @@
Configuring Redis database
==========================
These are instructions for setting up NNTPChan with Redis as the data-storage system.
##Configuring Redis
In `srnd.ini` the database sections should look like this:
[database]
type=redis
schema=single
host=localhost
port=6379
user=
password=
##Securing Redis (optional)
Read [Securing Redis](securing-redis.md) for adding password authentication to your Redis server.

View File

@ -1,15 +0,0 @@
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 "requirepass x" >> /path/to/your/redis.conf

View File

@ -17,18 +17,6 @@ First your will be asked what data-storage system you would like to use. We supp
<hr> <hr>
####Redis configuration
![Image 2](http://i.imgur.com/HDp4Ddf.png)
**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).
* **Port number** - The port that your Redis server is running on.
* **Password** - Optional authentication password for Redis ([Setting up a Redis password](database/redis/securing-redis.md)).
<hr>
#### Postgres configuration #### Postgres configuration
@ -81,6 +69,5 @@ Check out the following in order:
1. 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/configure-postgres.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) 2. [Setting up NNTPChan system](srnd.md)
3. [Setting up feeds](feeds.md) 3. [Setting up feeds](feeds.md)