2e7cb4ad66
Problem: A big chunk of both the readme and the startup output is dedicated to configuration, which feels to me to be focused on developers and advanced users rather than beginners who just want to try using Oasis. Solution: Move readme configuration info to its own file and hide all config output (except one line) behind `--debug`. While doing this I noticed that we're `require()`ing a few modules that we don't need before setting `process.env.DEBUG`, which I've reorganized so that we don't accidentally disable debug mode for those modules.
29 lines
922 B
Markdown
29 lines
922 B
Markdown
# Configuring
|
|
|
|
The default options can be permanently set with a configuration file found in a
|
|
standard folder for configuration, depending on your operating system:
|
|
|
|
- Linux: `$XDG_CONFIG_HOME/oasis/default.json`.
|
|
Usually this is `/home/<your username>/.config/oasis/default.json`
|
|
<!-- cspell:disable-next-line -->
|
|
- Windows `%APPDATA%\oasis\default.json`.
|
|
- Mac OS, `/Users/<your username>/Library/Preferences/oasis/default.json`
|
|
|
|
The configuration file can override any or all of the command-line _defaults_.
|
|
Here is an example customizing the port number and the "open" settings:
|
|
|
|
```json
|
|
{
|
|
"open": false,
|
|
"port": 19192
|
|
}
|
|
```
|
|
|
|
## Semantics
|
|
|
|
Which value is given is decided like this:
|
|
|
|
1. If an argument is given on the command-line, use that value.
|
|
2. Otherwise, use the value from the configuration file if present.
|
|
3. If neither command-line nor configuration file are given, use the built-in default value.
|