shuo-docs/Configuration.md

54 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2015-08-06 02:55:25 +00:00
This part of the documentation will focus on the configuration of your Shuo server. Start by locating the `config.js` file in the Shuo folder.
2015-08-06 02:36:41 +00:00
To quickly open the config:
2015-08-06 02:55:25 +00:00
```console
$ shuo config
2015-08-06 02:36:41 +00:00
```
## public
This setting can be either `true` or `false`. Public servers require no authentication. This is the default mode. Set to `false` to enable user login.
## host
Listen to connections only from this host. Default `0.0.0.0` will allow connections from anyone.
## port
The port to listen on.
2015-08-06 02:55:25 +00:00
You can override this setting by starting Shuo like this:
```console
$ shuo start --port 80
```
2015-08-06 02:36:41 +00:00
## theme
2015-08-06 02:55:25 +00:00
This setting should point to a stylesheet in your Shuo folder. If you want to create your own theme, it's recommended that you add your own stylesheet to `shout/client/themes/`.
2015-08-06 02:36:41 +00:00
## home
2015-08-06 02:55:25 +00:00
Use this setting to override the default `HOME` location. The home folder is where Shuo will locate the `users/` and `cache/` folder. Leaving this field empty will default to `~/.shout/`.
2015-08-06 02:36:41 +00:00
## logs
Change how the logs will be stored. Remember that logging has to be turned on per user, in their own `user.json`.
- format
- timezone
## defaults
These are the placeholder values displayed in the __Connect__ form:
- name
- host
- port
- password
- tls
- nick
- realname
2015-08-06 02:55:25 +00:00
- join