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.
f1adf381ce
nntpchan/doc
History
Jeff Becker 61c35b7652
* change feed defaults to be sane 
* update docs

* add git revision to version

* bump to 2.5.1
2017-09-24 10:00:03 -04:00
..
database/postgres update docs 2017-04-04 09:01:43 -04:00
developer * change feed defaults to be sane 2017-09-24 10:00:03 -04:00
extras Bundled images 2017-01-27 11:24:03 -05:00
building.md * change feed defaults to be sane 2017-09-24 10:00:03 -04:00
cli.md update docs 2017-09-04 07:58:40 -04:00
feeds.md update docs 2017-04-04 09:01:43 -04:00
moderation.md update docs 2017-04-04 09:01:43 -04:00
README.md * change feed defaults to be sane 2017-09-24 10:00:03 -04:00
running.md fix docs 2017-09-04 07:55:57 -04:00
setting-up.md fix docs 2017-09-04 07:55:57 -04:00
srnd.md update docs 2017-04-04 09:01:43 -04:00
tripcode-0.png don't use imgur 2016-11-10 15:14:17 -05:00
tripcode-1.png don't use imgur 2016-11-10 15:14:17 -05: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. Moderating NNTPChan - Keep your node clean
  6. 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
  3. In Progress Sub Projects - Ongoing subprojects that are not deployed on the mainline network yet