* Updated quickstart just slightly
* Start work on config.md configuration notes
This commit is contained in:
parent
55c9d557db
commit
09f6ad1d0c
|
@ -0,0 +1,22 @@
|
|||
## 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
|
||||
The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. This file shoudl be created in `~/.config/enigma-bbs/config.hjson`. Values found in core/config.js may be overridden by simply providing the object members you wish replace.
|
||||
|
||||
#### Example: System Name
|
||||
`core/config.js` provides the default system name as follows:
|
||||
```javascript
|
||||
general : {
|
||||
boardName : 'Another Fine ENiGMA½ System'
|
||||
}
|
||||
```
|
||||
|
||||
To override this for your own board, in `config.hjson`:
|
||||
```hjson
|
||||
general: {
|
||||
boardName: Super Fancy BBS
|
||||
}
|
||||
```
|
||||
|
||||
TODO: document Windows ~/... path example
|
|
@ -44,4 +44,7 @@ messages: {
|
|||
./main.js
|
||||
```
|
||||
|
||||
The first user you create via applying is the root SysOp.
|
||||
Some points of interest:
|
||||
* Default ports are 8888 (Telnet) and 8889 (SSH)
|
||||
* The first user you create via applying is the root SysOp.
|
||||
* You may want to tail the logfile with Bunyan: `tail -F ./logs/enigma-bbs.log | ./node_modules/bunyan/bin/bunyan`
|
Loading…
Reference in New Issue