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

Here is an example configuration file. It shows all the available settings and all their defaults.

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"

Which hostname to run the server on. The default value is auto. Auto means 127.0.0.1 in debug mode, otherwise, all interfaces. If you don’t know what this means, don’t change it.

value
port : value = "10416"

Which port to run the server on.

value
canonical_origin : value = ""

The primary URL where people can access the homepage of your instance.

For example, https://breezewiki.com

value
debug : boolean = "false"

Enables debugging mode, for debugging BreezeWiki during development.

Enables more runtime checks and more verbose output. Turns off some browser caching.

value
feature_search_suggestions : boolean = "true"

Enables the search suggestions feature.

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"

Whether to log outgoing requests to Fandom to the console.

value
strict_proxy : boolean = "true"

Whether to put more URLs through the proxy. If false, just a minimal set is proxied. If true, additionally proxies page stylesheets and links to image files, thereby reducing the potential for end-users to connect to Fandom servers.

contents ← prev up next →

1	Links
2	Automatic Redirection
3	Reporting Bugs
4	Running
5	Configuration
6	Developing Breeze Wiki

5.1	File
5.2	Environment variables
5.3	Required options
5.4	Detailed Options