moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean up NNTP docs

This commit is contained in:
Bryan Ashby 2022-09-25 10:01:27 -06:00
parent 3155a0cd81
commit 1626db3d52
No known key found for this signature in database
GPG Key ID: C2C1B501E4EFD994
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/_docs/servers/contentservers/nntp.md
View File

@ -6,15 +6,17 @@ title: NNTP Server
The NNTP *content server* provides access to publicly exposed message conferences and areas over either **secure** NNTPS (NNTP over TLS or nttps://) and/or non-secure NNTP (nntp://).
## Configuration
The following keys are available within the `contentServers.nntp` configuration block:
| Item | Required | Description |
|------|----------|-------------|
| `nntp` | :-1: | Configuration block for non-secure NNTP. See Non-Secure NNTP Configuration below. |
| `nntps` | :-1: | Configuration block for secure NNTP. See Secure NNTPS Configuration below. |
| `publicMessageConferences` | :+1: | A map of *conference tags* to *area tags* that are publicly exposed over NNTP. Anonymous users will get read-only access to these areas. |
| `allowPosts` | :-1: | Allow posting from authenticated users. See [Write Access](#write-access). Default is `false`.
| `nntp` | :-1: | Configuration block for non-secure NNTP. See [Non-Secure NNTP Configuration](#non-secure-configuration). |
| `nntps` | :-1: | Configuration block for secure NNTP. See [Secure Configuration (NNTPS)](#secure-configuration-nntps) |
| `publicMessageConferences` | :+1: | A map of *conference tags* to *area tags* that are publicly exposed over NNTP. <u>Anonymous users will gain read-only access to these areas</u>. |
| `allowPosts` | :-1: | Allow posting from <u>authenticated users</u>. See [Write Access](#write-access). Default is `false`.
### See Non-Secure NNTP Configuration
### Non-Secure Configuration
Under `contentServers.nntp.nntp` the following configuration is allowed:
| Item | Required | Description |
@ -22,7 +24,7 @@ Under `contentServers.nntp.nntp` the following configuration is allowed:
| `enabled` | :+1: | Set to `true` to enable non-secure NNTP access. |
| `port` | :-1: | Override the default port of `8119`. |
### Secure NNTPS Configuration
### Secure Configuration (NNTPS)
Under `contentServers.nntp.nntps` the following configuration is allowed:
| Item | Required | Description |
@ -35,7 +37,7 @@ Under `contentServers.nntp.nntps` the following configuration is allowed:
#### Certificates and Keys
In order to use secure NNTPS, a TLS certificate and key pair must be provided. You may generate your own but most clients **will not trust** them. A certificate and key from a trusted Certificate Authority is recommended. [Let's Encrypt](https://letsencrypt.org/) provides free TLS certificates. Certificates and private keys must be in [PEM format](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail).
##### Generating Your Own
##### Generating a Certificate & Key Pair
An example of generating your own cert/key pair:
```bash
openssl req -newkey rsa:2048 -nodes -keyout ./config/nntps_key.pem -x509 -days 3050 -out ./config/nntps_cert.pem