21 lines
1.2 KiB
Markdown
21 lines
1.2 KiB
Markdown
NNTPChan Documentation
|
|
======================
|
|
**WARNING: Caching with redis was deprecated in [commit 96de42](https://github.com/majestrate/srndv2/commit/96de42bf5d689a54d27871c9f8bc4ef3d0cdbefc). 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.md) - Building the source code
|
|
2. [Setting up NNTPChan](setting-up.md) - Configuring the node
|
|
3. [Running NNTPChan](running.md) - Running the node for the first time
|
|
4. [Managing your NNTPChan node with the CLI](cli.md) - Manage many aspects of your node via the command-line interface
|
|
5. [Moderating NNTPChan](moderation.md) - Keep your node clean
|
|
5. [Configuring your news reader for NNTPChan](extras/configure-newsreader.md) - Setup **Mozilla Thunderbird** or **Pan** to send and receive articles from your NNTPChan node of choice.
|
|
|
|
## Developer related
|
|
|
|
1. [Protocol](developer/protocol.md) - NNTPChan's protocol specification
|
|
2. [JSON-RPC API](developer/api.md) - NNTPChan's JSON-RPC API
|
|
3. [In Progress Sub Projects](developer/subprojects.md) - Ongoing subprojects that are not deployed on the mainline network yet
|