From 7a60f91e3147625bd7845dc8dd921f3a37f0e37d Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 2 Jul 2016 14:16:01 -0600 Subject: [PATCH] Minor doc updates related to oputil.js --- docs/config.md | 3 +++ docs/index.md | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/docs/config.md b/docs/config.md index afdcf4e2..00ea751e 100644 --- a/docs/config.md +++ b/docs/config.md @@ -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* +### oputil.js +Please see `oputil.js config` for configuration generation options. + ### Example: System Name `core/config.js` provides the default system name as follows: ```javascript diff --git a/docs/index.md b/docs/index.md index 6e2e4bb1..5387030a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,6 +43,15 @@ openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048 ## 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. +### 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 { general: {