Skip to main content

​
Configuration tables

The Coral server is configured using configuration tables. The following tables are available:
TableDescription
authenticationConfigure access to the Coral server
consoleConfiguration for the built-in Coral console
debugDebugging configuration
dockerDocker runtime configuration
loggingLogging configuration
networkNetwork configuration
registryAgent registry configuration

​
Setting configuration options

Configuration options can be set with two different methods. 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
./gradlew run --args="--auth.keys=dev"
NPM
npx coralos-dev@latest -- server start -- --auth.keys="dev"
The syntax for specifying command line options is --<table>.<key>=<value>, keys can be specified in:
  • lower case
  • camel case
  • snake case

​
2. 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. Example:
Environment variables
CONFIG_FILE_PATH=/path/to/config.toml
/path/to/config.toml
[auth]
keys = ["my access key"]
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.