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

Merge pull request #554 from voipmeister/master

Browse Source 
Describing maxMessages and maxAgeDays parameters for message areas
This commit is contained in:
Bryan Ashby
2024-08-27 13:11:51 -06:00
committed by GitHub
parent 0d34f16c4e ae6ecdee48
commit cd1ba6f71f
3 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/_docs/admin/administration.md
View File

@@ -33,7 +33,10 @@ done
### Backup Tools ### Backup Tools
There are many backup solutions available across all platforms. Configuration of such tools is outside the scope of this documentation. With that said, the author has had great success with [Borg](https://www.borgbackup.org/). There are many backup solutions available across all platforms. Configuration of such tools is outside the scope of this documentation. With that said, the author has had great success with [Borg](https://www.borgbackup.org/).
## General Maintenance Tasks ## General Maintenance
### Default Maintenance Tasks
Several default maintenance tasks are defined as events in `core/config_default.js`, in the section `eventScheduler`. These events run at various times and perform several maintenance tasks. An example is the `trimMessageAreas` event, which is run every 24 hours and defines that the action `trimMessageAreasScheduledEvent` is performed.
### Vacuuming Database Files ### Vacuuming Database Files
SQLite database files become less performant over time and waste space. It is recommended to periodically vacuum your databases. Before proceeding, you should make a backup! SQLite database files become less performant over time and waste space. It is recommended to periodically vacuum your databases. Before proceeding, you should make a backup!

8
docs/_docs/messageareas/configuring-a-message-area.md
View File

@@ -53,10 +53,14 @@ Message Areas are topic specific containers for messages that live within a part
| `desc` | :+1: | Friendly area description. | | `desc` | :+1: | Friendly area description. |
| `sort` | :-1: | Set to a number to override the default alpha-numeric sort order based on the `name` field. | | `sort` | :-1: | Set to a number to override the default alpha-numeric sort order based on the `name` field. |
| `default` | :-1: | Specify `true` to make this the default area (e.g. assigned to new users) | | `default` | :-1: | Specify `true` to make this the default area (e.g. assigned to new users) |
| `acs` | :-1: | A standard [ACS](../configuration/acs.md) block. See **ACS** below. | | `acs` | :-1: | A standard [ACS](../configuration/acs.md) block. See **ACS** below. |
| `maxMessages` | :-1: | The maximum number of messages to keep in the area. Defaults to `1024`. |
| `maxAgeDays` | :-1: | The maximum age of messages to keep in the area. Defaults to `0`, which means unlimited. |
| `autoSignatures` | :-1: | Set to `false` to disable auto-signatures in this area. | | `autoSignatures` | :-1: | Set to `false` to disable auto-signatures in this area. |
| `realNames` | :-1: | Set to `true` to use real names in this area. | | `realNames` | :-1: | Set to `true` to use real names in this area. |
The default values for `maxMessages` and `maxAgeDays` can be changed globally in `core/config_default.js`, they're located in the section `messageAreaDefaults`. The same file also defines several default events to be scheduled, which are located under `eventScheduler`. For example, the `trimMessageAreas` event is run every 24 hours and defines that the action `trimMessageAreasScheduledEvent` is performed.
### ACS ### ACS
An optional standard [ACS](../configuration/acs.md) block can be supplied with the following rules: An optional standard [ACS](../configuration/acs.md) block can be supplied with the following rules:
* `read`: ACS required to read (see) this area. Defaults to `GM[users]`. * `read`: ACS required to read (see) this area. Defaults to `GM[users]`.
@@ -74,6 +78,8 @@ messageConferences: {
desc: ENiGMA 1/2 development and discussion! desc: ENiGMA 1/2 development and discussion!
sort: 1 sort: 1
default: true default: true
maxMessages: 2000 // keep at most 2000 messages
maxAgeDays: 365 // delete anything older than 1 year
acs: { acs: {
read: GM[users] // default read: GM[users] // default
write: GM[l33t] // super elite ENiGMA 1/2 users! write: GM[l33t] // super elite ENiGMA 1/2 users!

4
docs/_docs/messageareas/netmail.md
View File

@@ -2,11 +2,11 @@
layout: page layout: page
title: Netmail title: Netmail
--- ---
ENiGMA support import and export of Netmail from the Private Mail area. `RiPuk @ 21:1/136` and `RiPuk <21:1/136>` 'To' address formats are supported. ENiGMA supports import and export of Netmail from the Private Mail area. `RiPuk @ 21:1/136` and `RiPuk <21:1/136>` 'To' address formats are supported.
## Netmail Routing ## Netmail Routing
A configuration block must be added to the `scannerTossers::ftn_bso` `config.hjson` section to tell the ENiGMA½ tosser where to route NetMail. A configuration block must be added to the `scannerTossers::ftn_bso` section in `config.hjson` to tell the ENiGMA½ tosser where to route NetMail.
The following configuration would tell ENiGMA½ to route all netmail addressed to 21:* through 21:1/100, and all 46:* netmail through 46:1/100: The following configuration would tell ENiGMA½ to route all netmail addressed to 21:* through 21:1/100, and all 46:* netmail through 46:1/100: