archive/nntpchan
Archived
1
0
Fork 0
Code
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.
561a0156be
nntpchan/doc
History
wzeth 4ab90f3152 Explicit notice of redis cache deprecation 
Users should know that redis cache is no longer valid as of SRNDv2 commit 96de42
2016-10-08 05:08:46 -04: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 Update building-debian8.5.md 2016-06-15 10:33:10 +00: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
README.md Explicit notice of redis cache deprecation 2016-10-08 05:08:46 -04: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

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

##Developer related

  1. Protocol - NNTPChan's protocol specification
  2. JSON-RPC API - NNTPChan's JSON-RPC API