TypeDB Configuration
You can configure a TypeDB server via two means: a YAML config file or command line options. Command line options override values defined in the config file.
For a full list of configurable properties run:
typedb server --help
This page lists & explains the available options.
General CLI arguments
General, non-configuration arguments available on the CLI.
General CLI arguments | ||
---|---|---|
|
Specify a custom configuration file |
|
|
|
Show help message. |
|
|
Print version information and exit. |
Configuration file
By default, TypeDB looks for a config.yml
file in the same folder as the TypeDB server executable (i.e., /server/config.yml
).
This path can be overridden using the CLI argument: --config <path-to-your-config>
.
Command line overrides
When using the command line to override a specific option, all CLI arguments must:
-
start with the double dash prefix
--
, -
be separated from their value (if any) either by an equals sign (
--arg=val
) or a whitespace (--arg val
).
e.g., --server.address=0.0.0.0:1730
Configuration options
Server
The server
section of the configuration contains network and encryption options.
For example, a server can be booted up on 0.0.0.0:1730
by using this command:
typedb server --server.address=0.0.0.0:1730
Server |
|
|
Server host and port. Default value: |
|
Enable/disable HTTP endpoint. Default value: |
|
HTTP endpoint host and port. Cannot be the same as |
|
The amount of seconds generated authentication tokens will remain valid, specified in seconds. Default value: |
Encryption
Configure the TLS certificate & private-key to be used for inflight encryption.
Server encryption |
|
|
Enable in-flight encryption. Do not specify this argument to leave it disabled. |
|
Encryption certificate in PEM format. Must be supplied if encryption is enabled. |
|
Encryption certificate key. Must be supplied if encryption is enabled. |
|
Encryption CA in PEM format. (Optional) |
Storage
The storage
section of the configuration contains the storage layer options.
For production use, it is recommended that the |
Storage |
|
|
Path to the user data directory. Defaults to within the server distribution under |
Diagnostics
TypeDB optionally reports anonymous diagnostics to guide the development and optimisation of TypeDB. This data includes unexpected errors and occasional system status updates for number and size of databases, as well as numbers of transactions and queries executed per hour.
To see what information is being reported, enable and access the monitoring Web page of the server (e.g. localhost:4104/diagnostics?format=json
).
Diagnostics |
|
|
Enable usage metrics reporting by setting a boolean flag. Default value: |
|
Enable critical error reporting by setting a boolean flag. Default value: |
|
Enable a diagnostics monitoring HTTP endpoint by setting a boolean flag. Default value: |
|
Port on which to expose the diagnostics monitoring endpoint. Default value: |