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

Minor doc changes

Browse Source
This commit is contained in:
voipmeister
2023-12-30 15:24:08 +01:00
parent 6aa0c8679f
commit 467957b6b6
4 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -15,9 +15,9 @@ Monitor your system via the [Waiting For Caller (WFC)](../modding/wfc.md) screen
User management is currently handled via the [oputil CLI](oputil.md). User management is currently handled via the [oputil CLI](oputil.md).
## Backing Up Your System ## Backing Up Your System
It is *highly* recommended to perform **regular backups** of your system. Nothing is worse than spending a lot of time setting up a system only to have to go away unexpectedly! It is *highly* recommended to perform **regular backups** of your system. Nothing is worse than spending a lot of time setting up a system only to have it go away unexpectedly!
In general, simply creating a copy/archive of your system is enough for the default configuration. If you have changed default paths to point outside of your main ENiGMA½ installation take special care to ensure these are preserved as well. Database files may be in a state of flux when simply copying files. See [Database Backups](#database-backups) below for details on consistent backups. In general, simply creating a copy/archive of your system is enough for the default configuration. If you have changed default paths to point outside of your main ENiGMA½ installation, take special care to ensure these are preserved as well. Database files may be in a state of flux when simply copying files. See [Database Backups](#database-backups) below for details on consistent backups.
### Database Backups ### Database Backups
[SQLite's CLI backup command](https://sqlite.org/cli.html#special_commands_to_sqlite3_dot_commands_) can be used for creating database backup files. This can be performed as an additional step to a full backup to ensure the database is backed up in a consistent state (whereas simply copying the files does not make any guarantees). [SQLite's CLI backup command](https://sqlite.org/cli.html#special_commands_to_sqlite3_dot_commands_) can be used for creating database backup files. This can be performed as an additional step to a full backup to ensure the database is backed up in a consistent state (whereas simply copying the files does not make any guarantees).

2
docs/_docs/admin/oputil.md
View File

@@ -34,7 +34,7 @@ Commands break up operations by groups:
Global arguments apply to most commands and actions: Global arguments apply to most commands and actions:
* `--config`: Specify configuration directory if it is not the default of `./config/`. * `--config`: Specify configuration directory if it is not the default of `./config/`.
* `--no-prompt`: Assume defaults and do not prompt when posisible. * `--no-prompt`: Assume defaults and do not prompt when possible.
Type `./oputil.js <command> --help` for additional help on a particular command. The following sections will describe them. Type `./oputil.js <command> --help` for additional help on a particular command. The following sections will describe them.

6
docs/_docs/installation/hardware/rpi.md
View File

@@ -18,10 +18,10 @@ to get it written to an SD card.
2. Enable SSH (option 5, option P2) 2. Enable SSH (option 5, option P2)
3. Expand the filesystem to use the entire SD card (option 7, option A1) 3. Expand the filesystem to use the entire SD card (option 7, option A1)
3. Update & upgrade all packages: `apt-get update && apt-get upgrade` 3. Update & upgrade all packages: `sudo apt-get update && sudo apt-get upgrade`
4. Install required packages: `sudo apt install lrzsz p7zip-full` 4. Install required packages: `sudo apt install git lrzsz p7zip-full`
5. Follow the [installation instructions](../installation/) to install ENiGMA½. 5. Follow the [installation instructions](../install-script.html) to install ENiGMA½.
6. Profit! 6. Profit!

3
docs/_docs/modding/wfc.md
View File

@@ -22,7 +22,7 @@ The system allows any user with the proper security to access the WFC / system o
Adding your user to the `wfc` group: Adding your user to the `wfc` group:
```bash ```bash
# Repalce USERNAME with your leet +op username # Replace USERNAME with your leet +op username
./oputil.js user group USERNAME "+wfc" ./oputil.js user group USERNAME "+wfc"
``` ```
@@ -43,6 +43,7 @@ mainMenuWaitingForCaller: {
## Configuration ## Configuration
### Config Block ### Config Block
The WFC `config` block allows for the following keys: The WFC `config` block allows for the following keys:
| Key | Required | Description | | Key | Required | Description |
|-----|----------|-------------| |-----|----------|-------------|
| `acs` | :+1: | See [Security](#security) above. | | `acs` | :+1: | See [Security](#security) above. |