From abad04af7315318b5347079866bc191b3cda4e6b Mon Sep 17 00:00:00 2001 From: voipmeister <12763807+voipmeister@users.noreply.github.com> Date: Tue, 27 Aug 2024 19:31:05 +0200 Subject: [PATCH 1/5] Textual changes --- docs/_docs/messageareas/netmail.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_docs/messageareas/netmail.md b/docs/_docs/messageareas/netmail.md index f43c2a4b1..dd8faedc8 100644 --- a/docs/_docs/messageareas/netmail.md +++ b/docs/_docs/messageareas/netmail.md @@ -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: From 3210822fb3bead6eb45cb5d959fcc6703e7780a6 Mon Sep 17 00:00:00 2001 From: voipmeister <12763807+voipmeister@users.noreply.github.com> Date: Tue, 27 Aug 2024 20:15:50 +0200 Subject: [PATCH 2/5] Describing maxMessages and maxAgeDays --- docs/_docs/messageareas/configuring-a-message-area.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/_docs/messageareas/configuring-a-message-area.md b/docs/_docs/messageareas/configuring-a-message-area.md index 2214e4373..a3684b83d 100644 --- a/docs/_docs/messageareas/configuring-a-message-area.md +++ b/docs/_docs/messageareas/configuring-a-message-area.md @@ -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`. + ### 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]`. @@ -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! From c8b2ef7f582d8b34066164d5a464a618d9e9d261 Mon Sep 17 00:00:00 2001 From: voipmeister <12763807+voipmeister@users.noreply.github.com> Date: Tue, 27 Aug 2024 20:58:38 +0200 Subject: [PATCH 3/5] Default Maintenance Tasks in administration.md --- docs/_docs/admin/administration.md | 5 ++++- docs/_docs/messageareas/configuring-a-message-area.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/_docs/admin/administration.md b/docs/_docs/admin/administration.md index 8988aea4b..dee6b055c 100644 --- a/docs/_docs/admin/administration.md +++ b/docs/_docs/admin/administration.md @@ -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 run. + ### 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! diff --git a/docs/_docs/messageareas/configuring-a-message-area.md b/docs/_docs/messageareas/configuring-a-message-area.md index a3684b83d..708d69d01 100644 --- a/docs/_docs/messageareas/configuring-a-message-area.md +++ b/docs/_docs/messageareas/configuring-a-message-area.md @@ -59,7 +59,7 @@ Message Areas are topic specific containers for messages that live within a part | `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 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 run. ### ACS An optional standard [ACS](../configuration/acs.md) block can be supplied with the following rules: From 1ff1e3efa12229b55cd5ed635410435b769815db Mon Sep 17 00:00:00 2001 From: voipmeister <12763807+voipmeister@users.noreply.github.com> Date: Tue, 27 Aug 2024 21:00:59 +0200 Subject: [PATCH 4/5] run -> performed --- docs/_docs/admin/administration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/admin/administration.md b/docs/_docs/admin/administration.md index dee6b055c..979dfe70c 100644 --- a/docs/_docs/admin/administration.md +++ b/docs/_docs/admin/administration.md @@ -35,7 +35,7 @@ There are many backup solutions available across all platforms. Configuration of ## 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 run. +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! From ae6ecdee48b994d15ee9714d174adc8a0d2f16fb Mon Sep 17 00:00:00 2001 From: voipmeister <12763807+voipmeister@users.noreply.github.com> Date: Tue, 27 Aug 2024 21:01:54 +0200 Subject: [PATCH 5/5] run -> performed --- docs/_docs/messageareas/configuring-a-message-area.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/messageareas/configuring-a-message-area.md b/docs/_docs/messageareas/configuring-a-message-area.md index 708d69d01..336d64dd4 100644 --- a/docs/_docs/messageareas/configuring-a-message-area.md +++ b/docs/_docs/messageareas/configuring-a-message-area.md @@ -59,7 +59,7 @@ Message Areas are topic specific containers for messages that live within a part | `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 run. +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: