zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-08-06 01:35:04 +02:00
Code Issues Projects Releases Packages Wiki Activity

Various minor doc updates

Browse source
This commit is contained in:
Bryan Ashby 2016-03-28 22:58:06 -06:00
parent 568a138cab
commit 00dcc2750b
4 changed files with 42 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/config.md
View file

@ -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.