This page describes how to set different settings in immudb.
Some of the most important settings that ones are:
| || ||System and user databases are stored here|
| || |
| || ||Listening address|
| || ||Listing port|
| || ||Whether to enable Mutual TLS (opens new window)|
| ||If specified, the server can sign the state the clients use to verify immutability|
| || ||If enabled, immudb will require user and password from the client|
| ||Client certificate authority|
| ||Maintenance mode. Override the authentication flag|
| ||Runs in sync mode. Prevents data loss but affects performance|
| || ||Client token expiry time, in minutes|
| || ||Embedded web console server|
| || ||Embeded web console port server|
| || ||pqsql protocol compatibility server (allows to connect from pgsql compatible clients)|
| || ||pqsql protocol compatibility server port|
Settings can be specified as command line options to immudb (see
immudb -h), in a configuration file, or as environment variables.
# Configuration file
Settings can be specified in a immudb.toml configuration file (opens new window).
Which configuration file to use is set with the
--config option. By default, immudb looks into the
configs subfolder in the current directory.
When running immudb as a service,
immudb service install allows to specify the configuration file to use with the
# Environment variables
Settings specified via environment variables take override the configuration file. They are specified in the form of
IMMUDB_, for example
IMMUDB_DIR specifies the