Archived

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.

History

Jeff Becker 3429ac63f8 add docs on moderation from anon		2016-11-10 15:11:09 -05:00
..
database	Use more succinct postgres role creation command	2016-09-10 09:34:00 -04:00
developer	Update and rename doc/protocol.md to doc/developer/protocol.md	2016-06-05 11:33:08 +02:00
extras	Merge pull request #118 from deavmi/patch-2	2016-06-30 06:46:19 -04:00
building-debian8.5.md	remove --createdb and upgrade go version	2016-10-20 12:51:06 -04:00
building-ubuntu16.10.md	fix typo	2016-10-27 03:06:57 -04:00
building.md	Update building.md	2016-07-21 20:57:04 +02:00
cli.md	Update cli.md	2016-06-05 12:12:05 +02:00
feeds.md	document SRND_FEEDS_INI_PATH environment variable	2016-06-20 10:09:24 +00:00
moderation.md	add docs on moderation from anon	2016-11-10 15:11:09 -05:00
README.md	add docs on moderation from anon	2016-11-10 15:11:09 -05:00
running.md	Update running.md	2016-06-05 12:11:40 +02:00
setting-up.md	Update setting-up.md	2016-06-05 13:31:46 +02:00
srnd.md	Update srnd.md	2016-07-07 19:04:19 +02:00

README.md

NNTPChan Documentation

WARNING: Caching with redis was deprecated in commit 96de42. Any reference to redis as a cache should be ignored. You should instead use null cache.

Hey, welcome to the documentation. This will help you use and develop with NNTPChan.

##End-user related

Building NNTPChan - Building the source code
Setting up NNTPChan - Configuring the node
Running NNTPChan - Running the node for the first time
Managing your NNTPChan node with the CLI - Manage many aspects of your node via the command-line interface
Moderating NNTPChan - Keep your node clean
Configuring your news reader for NNTPChan - Setup Mozilla Thunderbird or Pan to send and receive articles from your NNTPChan node of choice.

##Developer related

Protocol - NNTPChan's protocol specification
JSON-RPC API - NNTPChan's JSON-RPC API