* Move default cert path into config
* Update docs to reflect changes * More doc tweaks for new structure
This commit is contained in:
parent
3e268f4b27
commit
b25b96d9de
|
@ -124,8 +124,8 @@ function getDefaultConfig() {
|
||||||
|
|
||||||
loginAttempts : 3,
|
loginAttempts : 3,
|
||||||
|
|
||||||
menuFile : 'menu.hjson', // Override to use something else, e.g. demo.hjson. Can be a full path (defaults to ./mods)
|
menuFile : 'menu.hjson', // Override to use something else, e.g. demo.hjson. Can be a full path (defaults to ./config)
|
||||||
promptFile : 'prompt.hjson', // Override to use soemthing else, e.g. myprompt.hjson. Can be a full path (defaults to ./mods)
|
promptFile : 'prompt.hjson', // Override to use soemthing else, e.g. myprompt.hjson. Can be a full path (defaults to ./config)
|
||||||
},
|
},
|
||||||
|
|
||||||
// :TODO: see notes below about 'theme' section - move this!
|
// :TODO: see notes below about 'theme' section - move this!
|
||||||
|
@ -215,18 +215,18 @@ function getDefaultConfig() {
|
||||||
},
|
},
|
||||||
ssh : {
|
ssh : {
|
||||||
port : 8889,
|
port : 8889,
|
||||||
enabled : false, // defualt to false as PK/pass in config.hjson are required
|
enabled : false, // default to false as PK/pass in config.hjson are required
|
||||||
|
|
||||||
//
|
//
|
||||||
// Private key in PEM format
|
// Private key in PEM format
|
||||||
//
|
//
|
||||||
// Generating your PK:
|
// Generating your PK:
|
||||||
// > openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
|
// > openssl genrsa -des3 -out ./config/ssh_private_key.pem 2048
|
||||||
//
|
//
|
||||||
// Then, set servers.ssh.privateKeyPass to the password you use above
|
// Then, set servers.ssh.privateKeyPass to the password you use above
|
||||||
// in your config.hjson
|
// in your config.hjson
|
||||||
//
|
//
|
||||||
privateKeyPem : paths.join(__dirname, './../misc/ssh_private_key.pem'),
|
privateKeyPem : paths.join(__dirname, './../config/ssh_private_key.pem'),
|
||||||
firstMenu : 'sshConnected',
|
firstMenu : 'sshConnected',
|
||||||
firstMenuNewUser : 'sshConnectedNewUser',
|
firstMenuNewUser : 'sshConnectedNewUser',
|
||||||
},
|
},
|
||||||
|
@ -234,8 +234,8 @@ function getDefaultConfig() {
|
||||||
port : 8810, // ws://
|
port : 8810, // ws://
|
||||||
enabled : false,
|
enabled : false,
|
||||||
securePort : 8811, // wss:// - must provide certPem and keyPem
|
securePort : 8811, // wss:// - must provide certPem and keyPem
|
||||||
certPem : paths.join(__dirname, './../misc/https_cert.pem'),
|
certPem : paths.join(__dirname, './../config/https_cert.pem'),
|
||||||
keyPem : paths.join(__dirname, './../misc/https_cert_key.pem'),
|
keyPem : paths.join(__dirname, './../config/https_cert_key.pem'),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
@ -271,8 +271,8 @@ function getDefaultConfig() {
|
||||||
https : {
|
https : {
|
||||||
enabled : false,
|
enabled : false,
|
||||||
port : 8443,
|
port : 8443,
|
||||||
certPem : paths.join(__dirname, './../misc/https_cert.pem'),
|
certPem : paths.join(__dirname, './../config/https_cert.pem'),
|
||||||
keyPem : paths.join(__dirname, './../misc/https_cert_key.pem'),
|
keyPem : paths.join(__dirname, './../config/https_cert_key.pem'),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
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.
|
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 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.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.js` may be overridden by simply providing the object members you wish replace.
|
||||||
|
|
||||||
### Creating a Configuration
|
### Creating a Configuration
|
||||||
Your initial configuration skeleton can be created using the `oputil.js` command line utility. From your enigma-bbs root directory:
|
Your initial configuration skeleton can be created using the `oputil.js` command line utility. From your enigma-bbs root directory:
|
||||||
|
|
|
@ -51,7 +51,7 @@ npm install
|
||||||
## Generate a SSH Private Key
|
## Generate a SSH Private Key
|
||||||
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.
|
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
|
```bash
|
||||||
openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
|
openssl genrsa -des3 -out ./config/ssh_private_key.pem 2048
|
||||||
```
|
```
|
||||||
|
|
||||||
### Create a Minimal Config
|
### Create a Minimal Config
|
||||||
|
|
|
@ -3,7 +3,7 @@ ENiGMA½'s menu system is highly flexible and moddable. The possibilities are al
|
||||||
|
|
||||||
This document and others will refer to `menu.hjson`. This should be seen as an alias to `yourboardname.hjson` (or whatever you reference in `config.hjson` using the `menuFile` property — see below). By modifying your `menu.hjson` you will be able to create a custom experience unique to your board.
|
This document and others will refer to `menu.hjson`. This should be seen as an alias to `yourboardname.hjson` (or whatever you reference in `config.hjson` using the `menuFile` property — see below). By modifying your `menu.hjson` you will be able to create a custom experience unique to your board.
|
||||||
|
|
||||||
The default `menu.hjson` file lives within the `mods` directory. It is **highly recommended** to specify another file by setting the `menuFile` property in your `config.hjson` file:
|
The default `menu.hjson` file lives within the `config` directory. It is **highly recommended** to specify another file by setting the `menuFile` property in your `config.hjson` file:
|
||||||
```hjson
|
```hjson
|
||||||
general: {
|
general: {
|
||||||
/* Can also specify a full path */
|
/* Can also specify a full path */
|
||||||
|
|
|
@ -7,7 +7,7 @@ See [Configuration](config.md)
|
||||||
See [Menu System](menu_system.md)
|
See [Menu System](menu_system.md)
|
||||||
|
|
||||||
## Theming
|
## Theming
|
||||||
Take a look at how the default `luciano_blocktronics` theme found under `mods/themes` works!
|
Take a look at how the default `luciano_blocktronics` theme found under `art/themes` works!
|
||||||
|
|
||||||
TODO document me!
|
TODO document me!
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
# Mods
|
# Mods
|
||||||
|
Custom mods should be added to `/enigma-install-path/mods`.
|
||||||
|
|
||||||
## Existing Mods
|
## Existing Mods
|
||||||
* **Married Bob Fetch Event**: An event for fetching the latest Married Bob ANSI's for display on you board. ACiDic release [ACD-MB4E.ZIP](https://l33t.codes/outgoing/ACD/ACD-MB4E.ZIP). Can also be [found on GitHub](https://github.com/NuSkooler/enigma-bbs-married_bob_evt)
|
* **Married Bob Fetch Event**: An event for fetching the latest Married Bob ANSI's for display on you board. ACiDic release [ACD-MB4E.ZIP](https://l33t.codes/outgoing/ACD/ACD-MB4E.ZIP). Can also be [found on GitHub](https://github.com/NuSkooler/enigma-bbs-married_bob_evt)
|
||||||
|
|
Loading…
Reference in New Issue