Minor doc updates related to oputil.js

This commit is contained in:
Bryan Ashby 2016-07-02 14:16:01 -06:00
parent 0f022b8068
commit 7a60f91e31
2 changed files with 12 additions and 0 deletions

View File

@ -6,6 +6,9 @@ The main system configuration file, `config.hjson` both overrides defaults and p
**Windows note**: **~** resolves to *C:\Users\YOURLOGINNAME\* on modern installations, e.g. *C:\Users\NuSkooler\\.config\enigma-bbs\config.hjson* **Windows note**: **~** resolves to *C:\Users\YOURLOGINNAME\* on modern installations, e.g. *C:\Users\NuSkooler\\.config\enigma-bbs\config.hjson*
### oputil.js
Please see `oputil.js config` for configuration generation options.
### Example: System Name ### Example: System Name
`core/config.js` provides the default system name as follows: `core/config.js` provides the default system name as follows:
```javascript ```javascript

View File

@ -43,6 +43,15 @@ openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
## Create a Minimal Config ## Create a Minimal Config
The main system configuration is handled via `~/.config/enigma-bbs/config.hjson`. This is a [HJSON](http://hjson.org/) file (compiliant JSON is also OK). See [Configuration](config.md) for more information. The main system configuration is handled via `~/.config/enigma-bbs/config.hjson`. This is a [HJSON](http://hjson.org/) file (compiliant JSON is also OK). See [Configuration](config.md) for more information.
### Via oputil.js
`oputil.js` can be utilized to generate your **initial** configuration. **This is the recommended way for all new users**:
optutil.js config --new
You wil be asked a series of basic questions.
### Example Starting Configuration
```hjson ```hjson
{ {
general: { general: {