Archived
1
0
This repository has been archived on 2023-08-12. You can view files and clone it, but cannot push or open issues or pull requests.
nntpchan/doc/setting-up.md
2017-01-29 09:03:48 -05:00

87 lines
3.1 KiB
Markdown

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.
<hr>
###Selecting your data-storage system
![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 Postgres. Below we have configuration information for both Redis and Postgres.
<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
![Image 3](http://i.imgur.com/WPXedZB.png)
**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).
* **Port number** - This is the port that your Postgres server is running on.
* **Username** - The username for Postgres.
* **Password** - The password for Postgres.
<hr>
###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.
* **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** - Represents the `Common Name (CN)` in the TLS certificate
* **TLS keyname** - Represents the `Organization (O)` in the TLS certificate. Most nodes use `overchan`.
###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.
##Manual configuration (WIP)
Check out the following in order:
1. Setting up data-storage system (choose i or ii)
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)