5 Configuration
Please set up your configuration file. You must restart BreezeWiki for it to take effect.
5.1 File
Configuration options are added to the config.ini file. It is a regular INI file. When running from source, config.ini goes next to breezewiki.rkt in the root directory of the repo.
If you do not specify a specific option, the internal default will be used. If the file is missing or empty, all defaults will be used.
When running a compiled distribution of BreezeWiki, the main config.ini file will actually be a symlink to the real location of the file. Make sure not to erase the symlink, or your settings will be ignored!
5.1.1 Example
bind_host = auto |
port = 10416 |
canonical_origin = |
debug = false |
feature_search_suggestions = true |
log_outgoing = true |
strict_proxy = true |
5.1.2 Format
A line with an equals sign = defines one setting.
The text before the equals sign is the key.
The text after the equals sign is the value. It may be empty.
Quote marks are optional - they are never necessary.
Spacing around the equals sign is optional.
False values are represented by either empty space, or the text false. Anything else is True.
5.2 Environment variables
By popular demand, environment variables can be used as an alternative to the configuration file. The configuration file will be read first and will override the default settings, then, if any environment variables are present, they will override the values in the configuration files.
Environment variables start with bw_ and then the name of the setting. They can be uppercase or lowercase.
5.2.1 Example
Here is an example of using environment variables in a typical shell:
bw_port=4000 bw_debug=false racket dist.rkt |
5.3 Required options
No options are strictly required, but some are highly recommended, depending on where you’re running BreezeWiki.
When running for local development, debug = true is recommended.
When running in production, canonical_origin is highly recommended.
5.4 Detailed Options
value
bind_host : value = "auto"
value
port : value = "10416"
value
canonical_origin : value = ""
For example, https://breezewiki.com
value
debug : boolean = "false"
Enables more runtime checks and more verbose output. Turns off some browser caching.
value
feature_search_suggestions : boolean = "true"
When enabled, any text typed in the search box will be sent to Fandom servers in order to provide suggestions. It will be sent via the proxy if the strict_proxy option is set.
value
log_outgoing : boolean = "true"
value
strict_proxy : boolean = "true"