Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describing maxMessages and maxAgeDays parameters for message areas #554

Merged
merged 5 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/_docs/admin/administration.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@ done
### 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/).

## 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
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!

Expand Down
8 changes: 7 additions & 1 deletion docs/_docs/messageareas/configuring-a-message-area.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,14 @@ Message Areas are topic specific containers for messages that live within a part
| `desc` | :+1: | Friendly area description. |
| `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) |
| `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. |
| `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
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]`.
Expand All @@ -74,6 +78,8 @@ messageConferences: {
desc: ENiGMA 1/2 development and discussion!
sort: 1
default: true
maxMessages: 2000 // keep at most 2000 messages
maxAgeDays: 365 // delete anything older than 1 year
acs: {
read: GM[users] // default
write: GM[l33t] // super elite ENiGMA 1/2 users!
Expand Down
4 changes: 2 additions & 2 deletions docs/_docs/messageareas/netmail.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
layout: page
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

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:

Expand Down
Loading