From 00dcc2750b57b2fda0c279d9f1355265180c0302 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Mon, 28 Mar 2016 22:58:06 -0600 Subject: [PATCH] Various minor doc updates --- README.md | 7 +++++-- docs/config.md | 38 ++++++++++++++++++++++++++++++++------ docs/index.md | 2 +- docs/msg_networks.md | 4 ++++ 4 files changed, 42 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b1d12540..49906d2f 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ ENiGMA½ is a modern BBS software with a nostalgic flair! ## In the Works * More ES6+ usage, and **documentation**! * File areas -* ACS support for more areas +* More ACS support coverage * SysOp dashboard (ye ol' WFC) -* Missing functionality such as searching, pipe code support in message areas, etc. +* Missing functionality such as searching, message area coloring, etc. * String localization * A lot more! Feel free to request features via [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) @@ -61,6 +61,9 @@ Please see the [Quickstart](docs/index.md#quickstart) * [M. Griffin](https://github.com/M-griffin), author of [Enthral BBS](https://github.com/M-griffin/Enthral), [Oblivion/2 XRM](https://github.com/M-griffin/Oblivion2-XRM) and [EtherTerm](https://github.com/M-griffin/EtherTerm)! * [Caphood](http://www.reddit.com/user/Caphood), supreme SysOp of [BLACK ƒlag](http://www.bbsnexus.com/directory/listing/blackflag.html) BBS * Luciano Ayres of [Blocktronics](http://blocktronics.org/), creator of the "Mystery Skulls" default ENiGMA½ theme! +* Sudndeath for Xibalba ANSI work! +* Jack Phlash for kick ass ENiGMA½ and Xibalba ASCII (Check out [IMPURE60](http://pc.textmod.es/pack/impure60/)!!) +* Avon of [Agency BBS](http://bbs.geek.nz/) and fsxNet ## License Released under the [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause) license: diff --git a/docs/config.md b/docs/config.md index be2cad75..afdcf4e2 100644 --- a/docs/config.md +++ b/docs/config.md @@ -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. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 181de7a2..6e2e4bb1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 ``` diff --git a/docs/msg_networks.md b/docs/msg_networks.md index 2fe4832a..5660643f 100644 --- a/docs/msg_networks.md +++ b/docs/msg_networks.md @@ -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`.