enigma-bbs/docs/_docs/configuration/config-hjson.md

51 lines
2.3 KiB
Markdown
Raw Normal View History

---
layout: page
title: System Configuration
---
2017-02-10 03:48:44 +00:00
## System Configuration
2020-11-21 02:05:43 +00:00
The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. Defaults lived in `core/config_default.js`.
2020-11-21 02:05:43 +00:00
The default path is `/enigma-bbs/config/config.hjson` though this can be overridden using the `--config` parameter when invoking `main.js`.
:information_source: See also [Configuration Files](config-files.md). Additionally [HJSON General Information](hjson.md) may be helpful for more information on the HJSON format.
2017-09-29 22:45:59 +00:00
### Creating a Configuration
2018-11-23 18:05:51 +00:00
Your initial configuration skeleton should be created using the `oputil.js` command line utility. From your enigma-bbs root directory:
2017-09-29 22:45:59 +00:00
```
./oputil.js config new
```
You will be asked a series of questions to create an initial configuration.
2016-07-02 20:16:01 +00:00
2017-09-29 22:45:59 +00:00
### Overriding Defaults
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'
}
```
To override this for your own board, in `config.hjson`:
```hjson
general: {
boardName: Super Fancy BBS
}
```
2018-11-23 18:05:51 +00:00
(Note the very slightly [HJSON](hjson.md) different syntax. **You can use standard JSON if you wish!**)
2017-02-10 03:48:44 +00:00
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)!
2017-09-29 22:45:59 +00:00
2018-11-23 18:05:51 +00:00
### Configuration Sections
Below is a list of various configuration sections. There are many more, but this should get you started:
* [ACS](acs.md)
* [Archivers](archivers.md): Set up external archive utilities for handling things like ZIP, ARJ, RAR, and so on.
* [Email](email.md): System email support.
* [Event Scheduler](event-scheduler.md): Set up events as you see fit!
2020-11-22 20:53:47 +00:00
* [File Base](../filebase/index.md)
2018-11-23 18:05:51 +00:00
* [File Transfer Protocols](file-transfer-protocols.md): Oldschool file transfer protocols such as X/Y/Z-Modem!
2020-11-22 20:53:47 +00:00
* [Message Areas](../messageareas/configuring-a-message-area.md), [Networks](../messageareas/message-networks.md), [NetMail](../messageareas/netmail.md), etc.
2018-11-24 17:33:33 +00:00
* ...and a **lot** more! Explore the docs! If you can't find something, please contact us!
2018-11-23 18:05:51 +00:00