51 lines
2.3 KiB
Markdown
51 lines
2.3 KiB
Markdown
---
|
|
layout: page
|
|
title: System Configuration
|
|
---
|
|
## System Configuration
|
|
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`.
|
|
|
|
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.
|
|
|
|
### Creating a Configuration
|
|
Your initial configuration skeleton should be created using the `oputil.js` command line utility. From your enigma-bbs root directory:
|
|
```
|
|
./oputil.js config new
|
|
```
|
|
|
|
You will be asked a series of questions to create an initial configuration.
|
|
|
|
### 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
|
|
}
|
|
```
|
|
|
|
(Note the very slightly [HJSON](hjson.md) different syntax. **You can use standard JSON if you wish!**)
|
|
|
|
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)!
|
|
|
|
### 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!
|
|
* [File Base](../filebase/index.md)
|
|
* [File Transfer Protocols](file-transfer-protocols.md): Oldschool file transfer protocols such as X/Y/Z-Modem!
|
|
* [Message Areas](../messageareas/configuring-a-message-area.md), [Networks](../messageareas/message-networks.md), [NetMail](../messageareas/netmail.md), etc.
|
|
* ...and a **lot** more! Explore the docs! If you can't find something, please contact us!
|
|
|