Skip to main content

Configuration tables

The Coral server is configured using configuration tables. The following tables are available:

Setting configuration options

Configuration options can be set through command-line arguments, environment variables, and a configuration file. Configuration options set in a higher priority method will override options set in a lower priority method. In order of priority, highest to lowest:

1. Command line

Options can be specified via the command line. Depending on how the Coral server is started, the command line options may be specified in different ways, such as:
Gradle
The syntax for specifying command line options is --<table>.<key>=<value>, keys can be specified in:
  • lower case
  • camel case
  • snake case

2. Environment variables

Use two underscores between the table and the field: NETWORK__BIND_PORT=5555 sets network.bindPort. Single underscores separate words inside a field. See the environment variable reference.

3. Configuration file

The Coral server will load a TOML configuration file from a path specified by the CONFIG_FILE_PATH environment variable. There is no default location for the configuration file; if the environment variable is not set, no configuration file will be loaded from disk. Custom builds can also bundle an optional /config.toml resource; the standard build uses code defaults. Example:
Environment variables
/path/to/config.toml
If CONFIG_FILE_PATH is set, it must point to a valid and accessible configuration file.Pointing to an invalid configuration file will cause an error launching the Coral server.