mirror of
https://github.com/NuSkooler/enigma-bbs.git
synced 2025-07-25 03:58:17 +02:00
Various minor doc updates
This commit is contained in:
parent
568a138cab
commit
00dcc2750b
4 changed files with 42 additions and 9 deletions
|
@ -1,12 +1,12 @@
|
|||
## Configuration
|
||||
# Configuration
|
||||
Configuration files in ENiGMA½ are simple UTF-8 encoded [HJSON](http://hjson.org/) files. HJSON is just like JSON but simplified and much more resilient to human error.
|
||||
|
||||
### System Configuraiton
|
||||
## System Configuraiton
|
||||
The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. The default path is `~/.config/enigma-bbs/config.hjson` though you can override this with the `--config` parameter when invoking `main.js`. Values found in core/config.js may be overridden by simply providing the object members you wish replace.
|
||||
|
||||
**Windows note**: **~** resolves to *C:\Users\YOURLOGINNAME\* on modern installations, e.g. *C:\Users\NuSkooler\\.config\enigma-bbs\config.hjson*
|
||||
|
||||
#### Example: System Name
|
||||
### Example: System Name
|
||||
`core/config.js` provides the default system name as follows:
|
||||
```javascript
|
||||
general : {
|
||||
|
@ -21,8 +21,34 @@ general: {
|
|||
}
|
||||
```
|
||||
|
||||
#### A Sample Configuration
|
||||
Below is a **sample** `config.hjson` illustrating various (but not all!) elements that can be configured / tweaked.
|
||||
### Specific Areas of Interest
|
||||
|
||||
#### Archivers
|
||||
External archivers can be configured for various tasks such as EchoMail bundle handling.
|
||||
|
||||
TODO: Document further inc. Members & defaults
|
||||
|
||||
**Example**:
|
||||
|
||||
```hjson
|
||||
archivers: {'
|
||||
zip: {
|
||||
// byte signature in HEX of ZIP archives
|
||||
sig: "504b0304"
|
||||
// offset of sig
|
||||
offset: 0
|
||||
compressCmd: "7za"
|
||||
compressArgs: [ "a", "-tzip", "{archivePath}", "{fileList}" ]
|
||||
decompressCmd: "7za"
|
||||
decompressArgs: [ "e", "-o{extractPath}", "{archivePath}" ]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### A Sample Configuration
|
||||
Below is a **sample** `config.hjson` illustrating various (but certainly not all!) elements that can be configured / tweaked.
|
||||
|
||||
**This is for illustration purposes! Do not cut & paste this configuration!**
|
||||
|
||||
|
||||
```hjson
|
||||
|
@ -106,5 +132,5 @@ Below is a **sample** `config.hjson` illustrating various (but not all!) element
|
|||
}
|
||||
```
|
||||
|
||||
### Menus
|
||||
## Menus
|
||||
TODO: Documentation on menu.hjson, etc.
|
|
@ -35,7 +35,7 @@ npm install
|
|||
```
|
||||
|
||||
## Generate a SSH Private Key
|
||||
To utilize the SSH server, a SSH Private Key will need generated. This step can be skipped if desired by disabling the SSH server in `config.hjson`.
|
||||
To utilize the SSH server, a SSH Private Key will need generated. This step can be skipped if you do not wish to enable SSH access.
|
||||
```bash
|
||||
openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
|
||||
```
|
||||
|
|
|
@ -1,6 +1,10 @@
|
|||
# Message Networks
|
||||
Message networks are configured in `messageNetworks` section of `config.hjson`. Each network type has it's own sub section such as `ftn` for FidoNet Technology Network (FTN) style networks. Message Networks tie directly with [Message Areas](msg_conf_area.md) that are also defined in `config.hjson`.
|
||||
|
||||
**Members**:
|
||||
* `ftn`: Configure FTN networks (described below)
|
||||
* `originLine` (optional): Overrwrite the default origin line for networks that support it. For example: `originLine: Xibalba - xibalba.l33t.codes:44510`
|
||||
|
||||
## FidoNet Technology Network (FTN)
|
||||
FTN networks are configured under the `messageNetworks::ftn` section of `config.hjson`.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue