diff --git a/WHATSNEW.md b/WHATSNEW.md index e587adf8..35c26086 100644 --- a/WHATSNEW.md +++ b/WHATSNEW.md @@ -3,6 +3,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For ## 0.0.12-beta * The `master` branch has become mainline. What this means to users is `git pull` will always give you the latest and greatest. Make sure to read [Updating](/docs/admin/updating.md) and keep an eye on `WHATSNEW.md` (this file) and [UPGRADE](UPGRADE.md)! See also [ticket #276](https://github.com/NuSkooler/enigma-bbs/issues/276). +* The default configuration has been moved to [config_default.js](/core/config_default.js). ## 0.0.11-beta * Upgraded from `alpha` to `beta` -- The software is far along and mature enough at this point! diff --git a/docs/configuration/archivers.md b/docs/configuration/archivers.md index 3f5d941e..52f724e5 100644 --- a/docs/configuration/archivers.md +++ b/docs/configuration/archivers.md @@ -74,7 +74,7 @@ For `list` commands, the `entryMatch` key must be provided. This key should prov ``` ## Archive Formats -Archive formats can be defined such that ENiGMA½ can detect them by signature or extension, then utilize the correct *archiver* to process them. Formats are defined in the `archives:formats` key in `config.hjson`. Many differnet types come pre-configured (see `core/config.js`). +Archive formats can be defined such that ENiGMA½ can detect them by signature or extension, then utilize the correct *archiver* to process them. Formats are defined in the `archives:formats` key in `config.hjson`. Many differnet types come pre-configured (see `core/config_default.js`). ### Example Archive Format Configuration ``` diff --git a/docs/configuration/config-hjson.md b/docs/configuration/config-hjson.md index 38392943..6f426a68 100644 --- a/docs/configuration/config-hjson.md +++ b/docs/configuration/config-hjson.md @@ -3,7 +3,7 @@ layout: page title: System Configuration --- ## System Configuration -The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. The default path is `/enigma-bbs-install-path/config/config.hjson` though you can override the `config.hjson` location 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. +The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. The default path is `/enigma-bbs-install-path/config/config.hjson` though you can override the `config.hjson` location with the `--config` parameter when invoking `main.js`. Values found in `core/config_default.js` may be overridden by simply providing the object members you wish replace. See also [HJSON General Information](hjson.md) for more information on the HJSON format. @@ -16,7 +16,7 @@ Your initial configuration skeleton should be created using the `oputil.js` comm You will be asked a series of questions to create an initial configuration. ### Overriding Defaults -The file `core/config.js` provides various defaults to the system that you can override via `config.hjson`. For example, the default system name is defined as follows: +The file `core/config_default.js` provides various defaults to the system that you can override via `config.hjson`. For example, the default system name is defined as follows: ```javascript general : { boardName : 'Another Fine ENiGMA½ System' @@ -32,7 +32,7 @@ general: { (Note the very slightly [HJSON](hjson.md) different syntax. **You can use standard JSON if you wish!**) -While not everything that is available in your `config.hjson` file can be found defaulted in `core/config.js`, a lot is. [Poke around and see what you can find](https://github.com/NuSkooler/enigma-bbs/blob/master/core/config.js)! +While not everything that is available in your `config.hjson` file can be found defaulted in `core/config_default.js`, a lot is. [Poke around and see what you can find](https://github.com/NuSkooler/enigma-bbs/blob/master/core/config_default.js)! ### Configuration Sections Below is a list of various configuration sections. There are many more, but this should get you started: diff --git a/docs/configuration/file-transfer-protocols.md b/docs/configuration/file-transfer-protocols.md index 2f7d48ac..a7dec599 100644 --- a/docs/configuration/file-transfer-protocols.md +++ b/docs/configuration/file-transfer-protocols.md @@ -28,12 +28,12 @@ For protocols of type `external` the following members may be defined: * `sendCmd`: Required for protocols that can send (allow user downloads); The command/binary to execute. * `sendArgs`: Required if using `sendCmd`; An array of arguments. A placeholder of `{fileListPath}` may be used to supply a path to a **file containing** a list of files to send, or `{filePaths}` to supply *1:n* individual file paths to send. * `recvCmd`: Required for protocols that can receive (allow user uploads); The command/binary to execute. -* `recvArgs`: Required if using `recvCmd` and supporting **batch** uploads; An array of arguments. A placeholder of `{uploadDir}` may be used to supply the system provided upload directory. If `{uploadDir}` is not present, the system expects uploaded files to be placed in CWD which will be set to the upload directory. +* `recvArgs`: Required if using `recvCmd` and supporting **batch** uploads; An array of arguments. A placeholder of `{uploadDir}` may be used to supply the system provided upload directory. If `{uploadDir}` is not present, the system expects uploaded files to be placed in CWD which will be set to the upload directory. * `recvArgsNonBatch`: Required if using `recvCmd` and supporting non-batch (single file) uploads; A placeholder of `{fileName}` may be supplied to indicate to the protocol what the uploaded file should be named (this will be collected from the user before the upload starts). * `escapeTelnet`: Optional; If set to `true`, escape all internal Telnet related codes such as IAC's. This option is required for external protocol handlers such as `sz` and `rz` that do not escape themselves. ### Adding Your Own -Take a look a the example below as well as [core/config.js](/core/config.js). +Take a look a the example below as well as [core/config_default.js](/core/config_default.js). #### Example File Transfer Protocol Configuration ``` diff --git a/docs/modding/file-transfer-protocol-select.md b/docs/modding/file-transfer-protocol-select.md index 72b8d124..741b6fbb 100644 --- a/docs/modding/file-transfer-protocol-select.md +++ b/docs/modding/file-transfer-protocol-select.md @@ -9,5 +9,5 @@ The built in `file_transfer_protocol_select` module provides a way to select a l ### Theming The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`) (the protocol list): -* `name`: The name of the protocol. Each entry is +op defined in `config.hjson` with defaults found in `config.js`. Note that the standard `{text}` field also contains this value. +* `name`: The name of the protocol. Each entry is +op defined in `config.hjson` with defaults found in `config_default.js`. Note that the standard `{text}` field also contains this value. diff --git a/docs/servers/ssh.md b/docs/servers/ssh.md index 2f8b7769..45a6a3ea 100644 --- a/docs/servers/ssh.md +++ b/docs/servers/ssh.md @@ -17,7 +17,7 @@ Entries available under `config.loginServers.ssh`: | `enabled` | :+1: | Set to `true` to enable the SSH server. | | `port` | :-1: | Override the default port of `8443`. | | `address` | :-1: | Sets an explicit bind address. | -| `algorithms` | :-1: | Configuration block for SSH algorithms. Includes keys of `kex`, `cipher`, `hmac`, and `compress`. See the algorithms section in the [ssh2-streams](https://github.com/mscdex/ssh2-streams#ssh2stream-methods) documentation for details. For defaults set by ENiGMA½, see `core/config.js`. +| `algorithms` | :-1: | Configuration block for SSH algorithms. Includes keys of `kex`, `cipher`, `hmac`, and `compress`. See the algorithms section in the [ssh2-streams](https://github.com/mscdex/ssh2-streams#ssh2stream-methods) documentation for details. For defaults set by ENiGMA½, see `core/config_default.js`. | `traceConnections` | :-1: | Set to `true` to enable full trace-level information on SSH connections. ### Example Configuration