nntpchan/doc/setting-up.md

Configuring NNTPChan

This document provides a step-by-step guide to configurin your NNTPChan node.

##Configuring via web-interface (WIP)

You can configure NNTPChan via the web-interface by navigating your browser to http://127.0.0.1:18000.

---

###Selecting your data-storage system

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.

---

####Redis configuration

First Install and Configure Redis database. 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).

---

####Postgres configuration

First Install and Configure Postgres database. 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).
• Port number - This is the port that your Postgres server is running on.
• Username - The username for Postgres.
• Password - The password for Postgres.

---

###Configuring the NNTP server

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.
• 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

Fill in the fields required for the TLS security system.

• Hostname or IP address - FIXME.
• TLS keyname - FIXME.

###Set paths to external programs

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.

##Manual configuration (WIP)

Check out the following in order:

1. Setting up data-storage system (choose i or ii)
2. Setting up using Postgres
3. Setting up using Redis
4. Setting up NNTPChan system
5. Setting up feeds