ArangoDB Server Options

Usage: arangod [<options>]

The database directory can be specified as positional (unnamed) first parameter:

arangod /path/to/datadir

Or explicitly as named parameter:

arangod --database.directory /path/to/datadir

All other parameters need to be passed as named parameters. That is two hyphens followed by the option name, an equals sign or a space and finally the parameter value. The value needs to be wrapped in double quote marks if the value contains whitespace. Extra whitespace around = is allowed:

arangod --database.directory = "/path with spaces/to/datadir"

See Configuration if you want to translate startup parameters to configuration files or learn more about startup options in general.

See Fetch Current Configuration Options if you want to query the arangod server for the current settings at runtime.

General

Also see General details.

Name Type Description
check-configuration boolean Check the configuration and exit
This is a command, no value needs to be specified. The process terminates after executing the command.
config string The configuration file or ‘none’
Default: ""
configuration string The configuration file or ‘none’
Default: ""
console boolean Start a JavaScript emergency console
This option can be specified without value to enable it.
Default: false
daemon boolean Background the server, running it as daemon
This option can be specified without value to enable it.
Default: false
default-language string ISO-639 language code
Default: ""
Deprecated in: v3.10.0
default-language-check boolean Check if default language matches stored language
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.0
define string… Define key=value for a @key@ entry in config file
Default: []
dump-dependencies boolean Dump dependency graph
This is a command, no value needs to be specified. The process terminates after executing the command.
dump-options boolean Dump configuration options in JSON format
This is a command, no value needs to be specified. The process terminates after executing the command.
fortune boolean Show fortune cookie on startup
This option can be specified without value to enable it.
Default: false
gid string Switch to group-id after reading config files
Default: ""
hund boolean Make ArangoDB bark on startup
This option can be specified without value to enable it.
Default: false
icu-language string ICU language
Default: ""
Introduced in: v3.9.1
log string… The global or topic-specific log level
Default: ["info","info"]
Deprecated in: v3.5.0
pid-file string Pid-file in daemon mode
Default: ""
supervisor boolean Background the server, starts a supervisor
This option can be specified without value to enable it.
Default: false
uid string Switch to user-id after reading config files
Default: ""
version boolean Reports the version and exits
This is a command, no value needs to be specified. The process terminates after executing the command.
version-json boolean Reports the version as JSON and exits
This is a command, no value needs to be specified. The process terminates after executing the command.
Introduced in: v3.9.0
working-directory string Working directory in daemon mode
Default: "/var/tmp"

Agency

Also see Agency details.

Name Type Description
agency.activate boolean Activate agency
This option can be specified without value to enable it.
Default: false
Effective on Agents only.
agency.compaction-keep-size uint64 Keep as many indices before compaction point
Default: 50000
Effective on Agents only.
agency.compaction-step-size uint64 Step size between state machine compactions
Default: 1000
Effective on Agents only.
agency.disaster-recovery-id string Allows for specification of the id for this agent; dangerous option for disaster recover only!
Default: ""
Effective on Agents only.
agency.election-timeout-max double Maximum timeout before an agent calls for new election (in seconds)
Default: 5
Effective on Agents only.
agency.election-timeout-min double Minimum timeout before an agent calls for new election (in seconds)
Default: 1
Effective on Agents only.
agency.endpoint string… Agency endpoints
Default: []
Effective on Agents only.
agency.max-append-size uint64 Maximum size of appendEntries document (# log entries)
Default: 250
Effective on Agents only.
agency.my-address string Which address to advertise to the outside
Default: ""
Effective on Agents only.
agency.pool-size uint64 Number of agent pool
Default: 1
Effective on Agents only.
agency.size uint64 Number of agents
Default: 1
Effective on Agents only.
agency.supervision boolean Perform arangodb cluster supervision
This option can be specified without value to enable it.
Default: false
Effective on Agents only.
agency.supervision-frequency double Arangodb cluster supervision frequency (in seconds)
Default: 1
Effective on Agents only.
agency.supervision-grace-period double Supervision time, after which a server is considered to have failed (in seconds)
Default: 10
Effective on Agents only.
agency.supervision-ok-threshold double Supervision time, after which a server is considered to be bad [s]
Default: 5
Effective on Agents only.
agency.wait-for-sync boolean Wait for hard disk syncs on every persistence call (required in production)
This option can be specified without value to enable it.
Default: true
Effective on Agents only.

ArangoSearch

Also see ArangoSearch details.

Name Type Description
arangosearch.commit-threads uint32 Upper limit to the allowed number of commit threads (0 == autodetect)
Default: 0
Introduced in: v3.7.5
arangosearch.commit-threads-idle uint32 Upper limit to the allowed number of idle threads to use for commit tasks (0 == autodetect)
Default: 0
Introduced in: v3.7.5
arangosearch.consolidation-threads uint32 Upper limit to the allowed number of consolidation threads (0 == autodetect)
Default: 0
Introduced in: v3.7.5
arangosearch.consolidation-threads-idle uint32 Upper limit to the allowed number of idle threads to use for consolidation tasks (0 == autodetect)
Default: 0
Introduced in: v3.7.5
arangosearch.threads uint32 The exact number of threads to use for asynchronous tasks (0 == autodetect)
Default: 0
Deprecated in: v3.7.5
arangosearch.threads-limit uint32 Upper limit to the autodetected number of threads to use for asynchronous tasks (0 == use default)
Default: 0
Deprecated in: v3.7.5

Audit

Also see Audit details.

Name Type Description
audit.hostname string Enterprise Edition only
Hostname to use
Default: ""
audit.max-entry-length uint32 Enterprise Edition only
Maximum length of a log entry (in bytes)
Default: 134217728
Introduced in: v3.8.0, v3.7.9
audit.output string… Enterprise Edition only
Audit destination(s)
Default: []
audit.queue boolean Enterprise Edition only
Queue audit log message before writing them out (can reduce latency)
This option can be specified without value to enable it.
Default: false
Introduced in: v3.8.0
audit.write-log-level boolean Enterprise Edition only
Add the log level of the audit event (TRACE, INFO, DEBUG, WARNING, ERROR) to audit log messages
This option can be specified without value to enable it.
Default: false
Introduced in: v3.9.0

Backup

Also see Backup details.

Name Type Description
backup.api-enabled string Whether the backup api is enabled (true) or not (false), or only enabled for superuser JWT (jwt)
Default: "true"
backup.local-path-prefix string This option restricts any backup target to a given path prefix
Default: "/"

Cache

Also see Cache details.

Name Type Description
cache.rebalancing-interval uint64 Microseconds between rebalancing attempts
Default: 2000000
cache.size uint64 Size of cache in bytes
Default: dynamic (e.g. 17872714752)

Cluster

Also see Cluster details.

Name Type Description
cluster.agency-endpoint string… Agency endpoint to connect to
Default: []
Effective on Coordinators and DB-Servers only.
cluster.api-jwt-policy string Access permissions required for accessing /_admin/cluster REST APIs (jwt-all = JWT required to access all operations, jwt-write = JWT required for post/put/delete operations, jwt-compat = 3.7 compatibility mode)
Default: "jwt-compat"
Possible values: “jwt-all”, “jwt-compat”, “jwt-write”
Effective on Coordinators only.
Introduced in: v3.8.0
cluster.create-waits-for-sync-replication boolean Active coordinator will wait for all replicas to create collection
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and DB-Servers only.
cluster.default-replication-factor uint32 Default replication factor for non-system collections
Default: 0
Effective on Coordinators only.
Introduced in: v3.6.0
cluster.force-one-shard boolean Force one-shard mode for all new collections
This option can be specified without value to enable it.
Default: false
Effective on Coordinators only.
Introduced in: v3.6.0
cluster.index-create-timeout double Amount of time (in seconds) the coordinator will wait for an index to be created before giving up
Default: 259200
Effective on Coordinators only.
cluster.max-number-of-move-shards uint32 Number of shards to be moved per rebalance operation. If value = 0, no shards will be moved
Default: 10
Effective on Coordinators only.
Introduced in: v3.9.0
cluster.max-number-of-shards uint32 Maximum number of shards when creating new collections (0 = unrestricted)
Default: 1000
Effective on Coordinators only.
Introduced in: v3.5.1
cluster.max-replication-factor uint32 Maximum replication factor for new collections (0 = unrestricted)
Default: 10
Effective on Coordinators only.
Introduced in: v3.6.0
cluster.min-replication-factor uint32 Minimum replication factor for new collections
Default: 1
Effective on Coordinators only.
Introduced in: v3.6.0
cluster.my-address string This server’s endpoint (cluster internal)
Default: ""
Effective on Coordinators and DB-Servers only.
cluster.my-advertised-endpoint string This server’s advertised endpoint (e.g. external IP address or load balancer, optional)
Default: ""
Effective on Coordinators and DB-Servers only.
cluster.my-role string This server’s role
Default: ""
cluster.require-persisted-id boolean If set to true, then the instance will only start if a UUID file is found in the database on startup. Setting this option will make sure the instance is started using an already existing database directory and not a new one. For the first start, the UUID file must either be created manually or the option must be set to false for the initial startup
This option can be specified without value to enable it.
Default: false
cluster.resign-leadership-on-shutdown boolean Create resign leader ship job for this dbsever on shutdown
This option can be specified without value to enable it.
Default: false
Effective on DB-Servers only.
cluster.shard-synchronization-attempt-timeout double Timeout (in seconds) for every shard synchronization attempt. running into the timeout will not lead to a synchronization failure, but will continue the synchronization shortly after. setting a timeout can help to split the replication of large shards into smaller chunks and release snapshots on the leader earlier
Default: 1200
Introduced in: v3.9.2
cluster.synchronous-replication-timeout-factor double All synchronous replication timeouts are multiplied by this factor
Default: 1
cluster.synchronous-replication-timeout-maximum double All synchronous replication timeouts will be at most this value (in seconds)
Default: 3600
Introduced in: v3.8.0
cluster.synchronous-replication-timeout-minimum double All synchronous replication timeouts will be at least this value (in seconds)
Default: 900
cluster.synchronous-replication-timeout-per-4k double All synchronous replication timeouts are increased by this amount per 4096 bytes (in seconds)
Default: 0.1
cluster.system-replication-factor uint32 Default replication factor for system collections
Default: 2
Effective on Coordinators only.
cluster.upgrade string Perform a cluster upgrade if necessary (auto = perform upgrade and shut down only if --database.auto-upgrade true is set, disable = never perform upgrade, force = always perform an upgrade and shut down, online = always perform an upgrade but don’t shut down)
Default: "auto"
Possible values: “auto”, “disable”, “force”, “online”
cluster.write-concern uint32 Write concern used for writes to new collections
Default: 1
Effective on Coordinators only.
Introduced in: v3.6.0

Database

Also see Database details.

Name Type Description
database.auto-upgrade boolean Perform a database upgrade if necessary
This option can be specified without value to enable it.
Default: false
database.check-version boolean Checks the versions of the database and exit
This is a command, no value needs to be specified. The process terminates after executing the command.
database.directory string Path to the database directory
Default: ""
database.extended-names-databases boolean Allow extended characters in database names
This option can be specified without value to enable it.
Default: false
Introduced in: v3.9.0
database.force-sync-properties boolean Force syncing of collection properties to disk, will use waitForSync value of collection when turned off
This option can be specified without value to enable it.
Default: true
database.ignore-datafile-errors boolean Load collections even if datafiles may contain errors
This option can be specified without value to enable it.
Default: false
database.init-database boolean Initializes an empty database
This is a command, no value needs to be specified. The process terminates after executing the command.
database.io-heartbeat boolean Perform IO heartbeat to test underlying volume
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.7
database.password string Initial password of root user
Default: ""
database.required-directory-state string Required state of database directory at startup (non-existing: database directory must not exist, existing: database directory must exist, empty: database directory must exist but be empty, populated: database directory must exist and contain specific files already, any: any state allowed)
Default: "any"
Possible values: “any”, “empty”, “existing”, “non-existing”, “populated”
database.restore-admin boolean Resets the admin users and sets a new password
This is a command, no value needs to be specified. The process terminates after executing the command.
database.upgrade-check boolean Skip a database upgrade
This option can be specified without value to enable it.
Default: true
database.wait-for-sync boolean Default wait-for-sync behavior, can be overwritten when creating a collection
This option can be specified without value to enable it.
Default: false

Encryption

Also see Encryption details.

Name Type Description
encryption.key-generator string Enterprise Edition only
Program providing the encryption key on stdout. If set, encryption will be enabled.
Default: ""
encryption.keyfile string Enterprise Edition only
File containing the encryption key. If set, encryption will be enabled.
Default: ""

Foxx

Also see Foxx details.

Name Type Description
foxx.allow-install-from-remote boolean Allow installing Foxx apps from remote URLs other than Github
This option can be specified without value to enable it.
Default: false
Effective on Coordinators and Single Servers only.
Introduced in: v3.8.5
foxx.api boolean Enables Foxx management REST APIs
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
foxx.force-update-on-startup boolean Ensure all Foxx services are synchronized before completeing the boot sequence
This option can be specified without value to enable it.
Default: false
Effective on Coordinators and Single Servers only.
Introduced in: v3.7.5
foxx.queues boolean Enable Foxx queues
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
foxx.queues-poll-interval double Poll interval (in seconds) for Foxx queue manager
Default: 1
Effective on Coordinators and Single Servers only.
foxx.store boolean Enables Foxx store in web interface
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0

Frontend

Also see Frontend details.

Name Type Description
frontend.proxy-request-check boolean Enable proxy request checking
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
frontend.trusted-proxy string… List of proxies to trust (may be IP or network). Make sure --frontend.proxy-request-check is enabled
Default: []
Effective on Coordinators and Single Servers only.
frontend.version-check boolean Alert the user if new versions are available
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.

HTTP

Also see HTTP details.

Name Type Description
http.allow-method-override boolean Allow HTTP method override using special headers
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.8.0
http.hide-product-header boolean Do not expose “Server: ArangoDB” header in HTTP responses
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.8.0
http.keep-alive-timeout double Keep-alive timeout in seconds
Default: 300
http.permanently-redirect-root boolean If true, use a permanent redirect. If false, use a temporary
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.12
http.redirect-root-to string Redirect of root URL
Default: "/_admin/aardvark/index.html"
Introduced in: v3.7.12
http.return-queue-time-header boolean If true, return the ‘x-arango-queue-time-seconds’ response header
This option can be specified without value to enable it.
Default: true
Introduced in: v3.9.0
http.trusted-origin string… Trusted origin URLs for CORS requests with credentials
Default: []

JavaScript

Also see JavaScript details.

Name Type Description
javascript.allow-admin-execute boolean For testing purposes allow ‘_admin/execute’, NEVER enable on production
This option can be specified without value to enable it.
Default: false
Effective on Coordinators and Single Servers only.
javascript.allow-external-process-control boolean Allow execution and control of external processes from within JavaScript actions
This option can be specified without value to enable it.
Default: false
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.allow-port-testing boolean Allow testing of ports from within JavaScript actions
This option can be specified without value to enable it.
Default: false
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.app-path string Directory for Foxx applications
Default: "./js/apps"
Effective on Coordinators and Single Servers only.
javascript.copy-installation boolean Copy contents of ‘javascript.startup-directory’ on first start
This option can be specified without value to enable it.
Default: false
Effective on Coordinators and Single Servers only.
javascript.enabled boolean Enable the V8 JavaScript engine
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
javascript.endpoints-allowlist string… Endpoints that can be connected to via @arangodb/request module in JavaScript actions
Default: []
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.endpoints-denylist string… Endpoints that cannot be connected to via @arangodb/request module in JavaScript actions (if not in allowlist)
Default: []
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.environment-variables-allowlist string… Environment variables that will be accessible in JavaScript
Default: []
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.environment-variables-denylist string… Environment variables that will be inaccessible in JavaScript (if not in allowlist)
Default: []
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.files-allowlist string… Filesystem paths that will be accessible from within JavaScript actions
Default: []
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.gc-frequency double JavaScript time-based garbage collection frequency (each x seconds)
Default: 60
Effective on Coordinators and Single Servers only.
javascript.gc-interval uint64 JavaScript request-based garbage collection interval (each x requests)
Default: 2000
Effective on Coordinators and Single Servers only.
javascript.harden boolean Disables access to JavaScript functions in the internal module: getPid() and logLevel()
This option can be specified without value to enable it.
Default: false
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.module-directory string… Additional paths containing JavaScript modules
Default: ["./enterprise/js"]
Effective on Coordinators and Single Servers only.
javascript.script string… Run scripts and exit
Default: []
javascript.script-parameter string… Script parameter
Default: []
javascript.startup-directory string Path to the directory containing JavaScript startup scripts
Default: "./js"
Effective on Coordinators and Single Servers only.
javascript.startup-options-allowlist string… Startup options whose names match this regular expression will be allowed and exposed to JavaScript
Default: []
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.startup-options-denylist string… Startup options whose names match this regular expression will not be exposed (if not in allowlist) to JavaScript actions
Default: []
Effective on Coordinators and Single Servers only.
Introduced in: v3.5.0
javascript.tasks boolean Enable JavaScript tasks
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
Introduced in: v3.8.0
javascript.transactions boolean Enable JavaScript transactions
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
Introduced in: v3.8.0
javascript.v8-contexts uint64 Maximum number of V8 contexts that are created for executing JavaScript actions
Default: 0
Effective on Coordinators and Single Servers only.
javascript.v8-contexts-max-age double Maximum age for each V8 context (in seconds) before it is disposed
Default: 60
Effective on Coordinators and Single Servers only.
javascript.v8-contexts-max-invocations uint64 Maximum number of invocations for each V8 context before it is disposed
Default: 0
Effective on Coordinators and Single Servers only.
javascript.v8-contexts-minimum uint64 Minimum number of V8 contexts that keep available for executing JavaScript actions
Default: 0
Effective on Coordinators and Single Servers only.
javascript.v8-max-heap uint64 Maximal heap size (in MB)
Default: 3072
javascript.v8-options string… Options to pass to v8
Default: []

LDAP

Also see LDAP details.

Name Type Description
ldap.allow-offline boolean Enterprise Edition only
If a refresh attempt fails to connect to the LDAP server, continue with the cached authentication data
This option can be specified without value to enable it.
Default: false
ldap.async-connect boolean Enterprise Edition only
Whether or not the connection to the LDAP library will be done asynchronously
This option can be specified without value to enable it.
Default: false
ldap.basedn string Enterprise Edition only
Ldap basedn, eg. dc=example,dc=com
Default: ""
ldap.binddn string Enterprise Edition only
Ldap binddn, eg. cn=admin,dc=example,dc=com
Default: ""
ldap.bindpasswd string Enterprise Edition only
Ldap bindpassword, eg. admin
Default: ""
ldap.debug boolean Enterprise Edition only
Turn on internal OpenLDAP library output (warning: will print to stdout)
This option can be specified without value to enable it.
Default: false
ldap.enabled boolean Enterprise Edition only
Enable LDAP
This option can be specified without value to enable it.
Default: false
ldap.network-timeout double Enterprise Edition only
Timeout value (in seconds) after which network operations following the initial connection return in case of no activity (a value of 0 means default timeout)
Default: 0
ldap.port uint16 Enterprise Edition only
Port to use
Default: 389
ldap.prefix string Enterprise Edition only
Ldap prefix, eg. uid= xor dn= xor cn=
Default: ""
ldap.referrals boolean Enterprise Edition only
Whether or not the LDAP library should implicitly chase referrals
This option can be specified without value to enable it.
Default: false
ldap.refresh-rate double Enterprise Edition only
Refresh user settings after this time (in seconds)
Default: 300
ldap.responsible-for string Enterprise Edition only
A file of usernames this provider is responsible for. If empty, it will be responsible for all users
Default: ""
Introduced in: v3.7.11
ldap.restart boolean Enterprise Edition only
Whether or not the LDAP library should implicitly restart connections
This option can be specified without value to enable it.
Default: false
ldap.retries uint32 Enterprise Edition only
Number of tries to attempt connecting to the LDAP server. Setting it to values greater than one will retry connecting in case the LDAP server is unavailable or denies the connection
Default: 1
ldap.roles-attribute-name string Enterprise Edition only
Ldap attributename where the role are located.
Default: ""
ldap.roles-exclude string Enterprise Edition only
Regexp to exclude groups. Leave empty to exclude none.
Default: ""
ldap.roles-include string Enterprise Edition only
Regexp to include groups. Leave empty to include all.
Default: ""
ldap.roles-search string Enterprise Edition only
Ldap search for roles; ‘{USER}’ is replaced by the ‘dn’ of the user.
Default: ""
ldap.roles-transformation string… Enterprise Edition only
Regexp to normalizer role name, e.g. ‘/^ (.[^ ]])*/$2/’
Default: []
ldap.search-attribute string Enterprise Edition only
Ldap search attribute, eg. uid
Default: "uid"
ldap.search-filter string Enterprise Edition only
Ldap search filter, eg. (objectClass=simpleSecurityObject)
Default: "objectClass=*"
ldap.search-scope string Enterprise Edition only
Ldap search scope, one of base, one, sub
Default: "sub"
ldap.serialize-timeout double Enterprise Edition only
Maximum amount of time (in seconds) that will be waited for the serialization mutex
Default: 5
ldap.serialized boolean Enterprise Edition only
Whether or not calls into the LDAP library should be serialized. This option can be used to work around thread-unsafe LDAP library functionality
This option can be specified without value to enable it.
Default: false
ldap.server string Enterprise Edition only
Server to use
Default: ""
ldap.suffix string Enterprise Edition only
Ldap suffix, eg. ,dc=example,dc=com
Default: ""
ldap.superuser-role string Enterprise Edition only
Role mapping to the super-users
Default: ""
ldap.timeout double Enterprise Edition only
Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout)
Default: 0
ldap.tls boolean Enterprise Edition only
Enable TLS
This option can be specified without value to enable it.
Default: false
ldap.tls-cacert-dir string Enterprise Edition only
Ldap tls cacert dir
Default: ""
ldap.tls-cacert-file string Enterprise Edition only
Ldap tls cacert file
Default: ""
ldap.tls-cert-check-strategy string Enterprise Edition only
Ldap tls cert check strategy, one of never, hard, demand, allow, try
Default: "hard"
ldap.tls-version string Enterprise Edition only
Ldap tls version, one of 1.0, 1.1, 1.2
Default: "1.2"
ldap.url string Enterprise Edition only
Ldap url, eg. ldap://example.com:389/dc=example,dc=com?uid?sub
Default: ""

LDAP2 (secondary server)

The ldap2.* options are identical to the ldap.* options, but configure a secondary LDAP server. See LDAP Secondary server options (ldap2).

Name Type Description
ldap2.allow-offline boolean Enterprise Edition only
If a refresh attempt fails to connect to the LDAP server, continue with the cached authentication data
This option can be specified without value to enable it.
Default: false
ldap2.async-connect boolean Enterprise Edition only
Whether or not the connection to the LDAP library will be done asynchronously
This option can be specified without value to enable it.
Default: false
ldap2.basedn string Enterprise Edition only
Ldap basedn, eg. dc=example,dc=com
Default: ""
ldap2.binddn string Enterprise Edition only
Ldap binddn, eg. cn=admin,dc=example,dc=com
Default: ""
ldap2.bindpasswd string Enterprise Edition only
Ldap bindpassword, eg. admin
Default: ""
ldap2.debug boolean Enterprise Edition only
Turn on internal OpenLDAP library output (warning: will print to stdout)
This option can be specified without value to enable it.
Default: false
ldap2.enabled boolean Enterprise Edition only
Enable LDAP
This option can be specified without value to enable it.
Default: false
ldap2.network-timeout double Enterprise Edition only
Timeout value (in seconds) after which network operations following the initial connection return in case of no activity (a value of 0 means default timeout)
Default: 0
ldap2.port uint16 Enterprise Edition only
Port to use
Default: 389
ldap2.prefix string Enterprise Edition only
Ldap prefix, eg. uid= xor dn= xor cn=
Default: ""
ldap2.referrals boolean Enterprise Edition only
Whether or not the LDAP library should implicitly chase referrals
This option can be specified without value to enable it.
Default: false
ldap2.refresh-rate double Enterprise Edition only
Refresh user settings after this time (in seconds)
Default: 300
ldap2.responsible-for string Enterprise Edition only
A file of usernames this provider is responsible for. If empty, it will be responsible for all users
Default: ""
Introduced in: v3.7.11
ldap2.restart boolean Enterprise Edition only
Whether or not the LDAP library should implicitly restart connections
This option can be specified without value to enable it.
Default: false
ldap2.retries uint32 Enterprise Edition only
Number of tries to attempt connecting to the LDAP server. Setting it to values greater than one will retry connecting in case the LDAP server is unavailable or denies the connection
Default: 1
ldap2.roles-attribute-name string Enterprise Edition only
Ldap attributename where the role are located.
Default: ""
ldap2.roles-exclude string Enterprise Edition only
Regexp to exclude groups. Leave empty to exclude none.
Default: ""
ldap2.roles-include string Enterprise Edition only
Regexp to include groups. Leave empty to include all.
Default: ""
ldap2.roles-search string Enterprise Edition only
Ldap search for roles; ‘{USER}’ is replaced by the ‘dn’ of the user.
Default: ""
ldap2.roles-transformation string… Enterprise Edition only
Regexp to normalizer role name, e.g. ‘/^ (.[^ ]])*/$2/’
Default: []
ldap2.search-attribute string Enterprise Edition only
Ldap search attribute, eg. uid
Default: "uid"
ldap2.search-filter string Enterprise Edition only
Ldap search filter, eg. (objectClass=simpleSecurityObject)
Default: "objectClass=*"
ldap2.search-scope string Enterprise Edition only
Ldap search scope, one of base, one, sub
Default: "sub"
ldap2.serialize-timeout double Enterprise Edition only
Maximum amount of time (in seconds) that will be waited for the serialization mutex
Default: 5
ldap2.serialized boolean Enterprise Edition only
Whether or not calls into the LDAP library should be serialized. This option can be used to work around thread-unsafe LDAP library functionality
This option can be specified without value to enable it.
Default: false
ldap2.server string Enterprise Edition only
Server to use
Default: ""
ldap2.suffix string Enterprise Edition only
Ldap suffix, eg. ,dc=example,dc=com
Default: ""
ldap2.superuser-role string Enterprise Edition only
Role mapping to the super-users
Default: ""
ldap2.timeout double Enterprise Edition only
Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout)
Default: 0
ldap2.tls boolean Enterprise Edition only
Enable TLS
This option can be specified without value to enable it.
Default: false
ldap2.tls-cacert-dir string Enterprise Edition only
Ldap tls cacert dir
Default: ""
ldap2.tls-cacert-file string Enterprise Edition only
Ldap tls cacert file
Default: ""
ldap2.tls-cert-check-strategy string Enterprise Edition only
Ldap tls cert check strategy, one of never, hard, demand, allow, try
Default: "hard"
ldap2.tls-version string Enterprise Edition only
Ldap tls version, one of 1.0, 1.1, 1.2
Default: "1.2"
ldap2.url string Enterprise Edition only
Ldap url, eg. ldap://example.com:389/dc=example,dc=com?uid?sub
Default: ""

Log

Also see Log details.

Name Type Description
log.api-enabled string Whether the log api is enabled (true) or not (false), or only enabled for superuser JWT (jwt)
Default: "true"
Introduced in: v3.4.11, v3.5.6, v3.6.5
log.color boolean Use colors for TTY logging
This option can be specified without value to enable it.
Default: dynamic (e.g. true)
log.escape-control-chars boolean Escape control characters when logging
This option can be specified without value to enable it.
Default: true
Introduced in: v3.9.0
log.escape-unicode-chars boolean Escape unicode characters when logging
This option can be specified without value to enable it.
Default: false
Introduced in: v3.9.0
log.file string Shortcut for ‘--log.output file://'
Default: ""
log.file-group string Group to use for new log file, user must be a member of this group
Default: ""
Introduced in: v3.4.5
log.file-mode string Mode to use for new log file, umask will be applied as well
Default: ""
Introduced in: v3.4.5
log.force-direct boolean Do not start a seperate thread for logging
This option can be specified without value to enable it.
Default: false
log.foreground-tty boolean Also log to tty if backgrounded
This option can be specified without value to enable it.
Default: dynamic (e.g. false)
log.hostname string Hostname to use in log message (empty for none, use ‘auto’ to automatically figure out hostname)
Default: ""
Introduced in: v3.8.0
log.ids boolean Log unique message ids
This option can be specified without value to enable it.
Default: true
Introduced in: v3.5.0
log.in-memory boolean Use in-memory log appender, which can be queried via API and web UI
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.0
log.in-memory-level string Use in-memory log appender only for this log level and higher
Default: "info"
Possible values: “debug”, “err”, “error”, “fatal”, “info”, “trace”, “warn”, “warning”
Introduced in: v3.7.9
log.keep-logrotate boolean Keep the old log file after receiving a sighup
This option can be specified without value to enable it.
Default: false
log.level string… The global or topic-specific log level
Default: ["info","info"]
log.line-number boolean Include the function name, file name and line number of the source code that issues the log message. Format: [func@FileName.cpp:123]
This option can be specified without value to enable it.
Default: false
log.max-entry-length uint32 Maximum length of a log entry (in bytes)
Default: 134217728
Introduced in: v3.7.9
log.output string… Log destination(s), e.g. file:///path/to/file (any ‘$PID’ will be replaced with the process id)
Default: []
log.performance boolean Shortcut for ‘--log.level performance=trace’
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0
log.prefix string Prefix log message with this string
Default: ""
log.process boolean Show process identifier (pid) in log message
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.0
log.request-parameters boolean Include full URLs and HTTP request parameters in trace logs
This option can be specified without value to enable it.
Default: true
log.role boolean Log server role
This option can be specified without value to enable it.
Default: false
log.shorten-filenames boolean Shorten filenames in log output (use with --log.line-number)
This option can be specified without value to enable it.
Default: true
log.structured-param string… Toggle usage of log category parameter in structured log messages
Default: []
Introduced in: v3.10.0
log.thread boolean Show thread identifier in log message
This option can be specified without value to enable it.
Default: false
log.thread-name boolean Show thread name in log message
This option can be specified without value to enable it.
Default: false
log.time-format string Time format to use in logs
Default: "utc-datestring"
Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis”
Introduced in: v3.5.0
log.use-json-format boolean Use json output format
This option can be specified without value to enable it.
Default: false
Introduced in: v3.8.0
log.use-local-time boolean Use local timezone instead of UTC
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0
log.use-microtime boolean Use microtime instead
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0

Network

Also see Network details.

Name Type Description
network.idle-connection-ttl uint64 Default time-to-live of idle connections for cluster-internal communication (in milliseconds)
Default: 120000
Introduced in: v3.6.0
network.io-threads uint32 Number of network IO threads for cluster-internal communication
Default: 2
Introduced in: v3.6.0
network.max-open-connections uint64 Max open TCP connections for cluster-internal communication per endpoint
Default: 1024
Introduced in: v3.6.0
network.max-requests-in-flight uint64 Controls the number of internal requests that can be in flight at a given point in time
Default: 65536
Introduced in: v3.8.0
network.protocol string Network protocol to use for cluster-internal communication
Default: ""
Possible values: “”, “h2”, “http”, “http2”, “vst”
Introduced in: v3.7.0
Deprecated in: v3.9.0
network.verify-hosts boolean Verify hosts when using TLS in cluster-internal communication
This option can be specified without value to enable it.
Default: false
Introduced in: v3.6.0

Query

Also see Query details.

Name Type Description
query.allow-collections-in-expressions boolean Allow full collections to be used in AQL expressions
This option can be specified without value to enable it.
Default: false
Introduced in: v3.8.0
Deprecated in: v3.9.0
query.cache-entries uint64 Maximum number of results in query result cache per database
Default: 128
query.cache-entries-max-size uint64 Maximum cumulated size of results in query result cache per database
Default: 268435456
query.cache-entry-max-size uint64 Maximum size of an invidiual result entry in query result cache
Default: 16777216
query.cache-include-system-collections boolean Whether or not to include system collection queries in the query result cache
This option can be specified without value to enable it.
Default: false
query.cache-mode string Mode for the AQL query result cache (on, off, demand)
Default: "off"
query.fail-on-warning boolean Whether AQL queries should fail with errors even for recoverable warnings
This option can be specified without value to enable it.
Default: false
query.global-memory-limit uint64 Memory threshold for all AQL queries combined (in bytes, 0 = no limit)
Default: dynamic (e.g. 59647057551)
Introduced in: v3.8.0
query.max-nodes-per-callstack uint64 Maximum number execution nodes on the callstack before splitting the remaining nodes into a separate thread
Default: 250
Introduced in: v3.9.0
query.max-parallelism uint64 Enterprise Edition only
Maximum number of threads to use for a single query; actual query execution may use less depending on various factors
Default: 4
Introduced in: v3.7.1
query.max-runtime double Runtime threshold for AQL queries (in seconds, 0 = no limit)
Default: 0
Introduced in: v3.6.7, v3.7.3
query.memory-limit uint64 Memory threshold per AQL query (in bytes, 0 = no limit)
Default: dynamic (e.g. 44183005593)
query.memory-limit-override boolean Allow increasing per-query memory limits for individual queries
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.0
query.optimizer-max-plans uint64 Maximum number of query plans to create for a query
Default: 128
query.optimizer-rules string… Enable or disable specific optimizer rules (use rule name prefixed with ‘-‘ for disabling, ‘+’ for enabling)
Default: []
Introduced in: v3.6.0
query.parallelize-gather-writes boolean Enable write parallelization for gather nodes
This option can be specified without value to enable it.
Default: true
Introduced in: v3.6.0
query.parallelize-traversals boolean Enterprise Edition only
Enable traversal parallelization
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.1
query.registry-ttl double Default time-to-live of cursors and query snippets (in seconds); if <= 0, value will default to 30 for single-server instances or 600 for coordinator instances
Default: 0
query.require-with boolean Whether AQL queries should require the WITH collection-name clause even on single servers (enable this to remove this behavior difference between single server and cluster)
This option can be specified without value to enable it.
Default: false
Introduced in: v3.8.0
query.slow-streaming-threshold double Threshold for slow streaming AQL queries (in seconds)
Default: 10
query.slow-threshold double Threshold for slow AQL queries (in seconds)
Default: 10
query.smart-joins boolean Enterprise Edition only
Enable SmartJoins query optimization
This option can be specified without value to enable it.
Default: true
Introduced in: v3.4.5
query.tracking boolean Whether to track queries
This option can be specified without value to enable it.
Default: true
query.tracking-slow-queries boolean Whether to track slow queries
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.4
query.tracking-with-bindvars boolean Whether to track bind vars with AQL queries
This option can be specified without value to enable it.
Default: true
query.tracking-with-datasources boolean Whether to track data sources with AQL queries
This option can be specified without value to enable it.
Default: false
Introduced in: v3.7.4
query.tracking-with-querystring boolean Whether to track the query string
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.4

Random

Also see Random details.

Name Type Description
random.generator uint32 Random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only)
Default: 1
Possible values: 1, 2, 3, 4

Rclone

Also see Rclone details.

Name Type Description
rclone.executable string Rclone executable used for up and download of backups
Default: ""

Replication

Also see Replication details.

Name Type Description
replication.active-failover boolean Enable active-failover during asynchronous replication
This option can be specified without value to enable it.
Default: false
replication.auto-start boolean Switch to enable or disable the automatic start of replication appliers
This option can be specified without value to enable it.
Default: true
replication.automatic-failover boolean Please use --replication.active-failover instead
This option can be specified without value to enable it.
Default: false
replication.connect-timeout double Default timeout value for replication connection attempts (in seconds)
Default: 10
Introduced in: v3.4.9, v3.5.4
replication.max-parallel-tailing-invocations uint64 Maximum number of concurrently allowed WAL tailing invocations (0 = unlimited)
Default: 0
Introduced in: v3.5.0
replication.quick-keys-limit uint64 Limit at which ‘quick’ calls to the replication keys API return only the document count for second run
Default: 1000000
Introduced in: v3.7.9
replication.request-timeout double Default timeout value for replication requests (in seconds)
Default: 600
Introduced in: v3.4.9, v3.5.4
replication.sync-by-revision boolean Whether to use the newer revision-based replication protocol
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.0

RocksDB

Also see RocksDB details.

Name Type Description
rocksdb.allow-fallocate boolean If true, allow RocksDB to use fallocate calls. if false, fallocate calls are bypassed
This option can be specified without value to enable it.
Default: true
Introduced in: v3.4.5
rocksdb.block-align-data-blocks boolean If true, aligns data blocks on lesser of page size and block size
This option can be specified without value to enable it.
Default: false
rocksdb.block-cache-shard-bits int64 Number of shard bits to use for block cache (use -1 for default value)
Default: -1
rocksdb.block-cache-size uint64 Size of block cache in bytes
Default: dynamic (e.g. 21447257702)
rocksdb.cache-index-and-filter-blocks boolean If turned on, the RocksDB block cache quota will also include RocksDB memtable sizes
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.1
rocksdb.cache-index-and-filter-blocks-with-high-priority boolean If true and --rocksdb.cache-index-and-filter-blocks is also true, cache index and filter blocks with high priority, making index and filter blocks be less likely to be evicted than data blocks
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.1
rocksdb.compaction-read-ahead-size uint64 If non-zero, we perform bigger reads when doing compaction. If you’re running RocksDB on spinning disks, you should set this to at least 2MB. that way RocksDB’s compaction is doing sequential instead of random reads.
Default: 2097152
rocksdb.create-sha-files boolean Enterprise Edition only
Enable generation of sha256 files for each .sst file
This option can be specified without value to enable it.
Default: true
Effective on DB-Servers and Single Servers only.
rocksdb.debug-logging boolean True to enable rocksdb debug logging
This option can be specified without value to enable it.
Default: false
Effective on DB-Servers and Single Servers only.
rocksdb.delayed-write-rate uint64 Limited write rate to DB (in bytes per second) if we are writing to the last mem-table allowed and we allow more than 3 mem-tables, or if we have surpassed a certain number of level-0 files and need to slowdown writes
Default: 0
rocksdb.dynamic-level-bytes boolean If true, determine the number of bytes for each level dynamically to minimize space amplification
This option can be specified without value to enable it.
Default: true
rocksdb.edge-cache boolean Use in-memory cache for edges
This option can be specified without value to enable it.
Default: true
Effective on DB-Servers and Single Servers only.
Introduced in: v3.6.4
Deprecated in: v3.10.0
rocksdb.enable-pipelined-write boolean If true, use a two stage write queue for WAL writes and memtable writes
This option can be specified without value to enable it.
Default: true
rocksdb.enable-statistics boolean Whether or not RocksDB statistics should be turned on
This option can be specified without value to enable it.
Default: false
rocksdb.encryption-gen-internal-key boolean Enterprise Edition only
Generate internal encryption-at-rest key.
This option can be specified without value to enable it.
Default: false
Introduced in: v3.7.1
rocksdb.encryption-hardware-acceleration boolean Enterprise Edition only
Use Intel intrinsics-based encryption, requiring a CPU with the AES-NI instruction set. If turned off, then OpenSSL is used, which may use hardware-accelarated encryption too.
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.0
rocksdb.encryption-key-generator string Enterprise Edition only
Program providing the encryption key on stdout. If set, encryption will be enabled.
Default: ""
rocksdb.encryption-key-rotation boolean Enterprise Edition only
Allow encryption key rotation
This option can be specified without value to enable it.
Default: false
Introduced in: v3.7.1
rocksdb.encryption-keyfile string Enterprise Edition only
File containing encryption key. If set, encryption will be enabled.
Default: ""
rocksdb.encryption-keyfolder string Enterprise Edition only
Folder containing all possible user encryption keys. All keys will be used to decrypt the internal keystore.
Default: ""
Introduced in: v3.7.0
rocksdb.enforce-block-cache-size-limit boolean If true, strictly enforces the block cache size limit
This option can be specified without value to enable it.
Default: true
rocksdb.exclusive-writes boolean If true, writes are exclusive. This allows the RocksDB engine to mimic the collection locking behavior of the now-removed MMFiles storage engine, but will inhibit concurrent write operations
This option can be specified without value to enable it.
Default: false
Introduced in: v3.5.4
Deprecated in: v3.8.0
rocksdb.intermediate-commit-count uint64 An intermediate commit will be performed automatically when this number of operations is reached in a transaction
Default: 1000000
rocksdb.intermediate-commit-size uint64 An intermediate commit will be performed automatically when a transaction has accumulated operations of this size (in bytes)
Default: 536870912
rocksdb.level0-compaction-trigger int64 Number of level-0 files that triggers a compaction
Default: 2
rocksdb.level0-slowdown-trigger int64 Number of level-0 files that triggers a write slowdown
Default: 16
rocksdb.level0-stop-trigger int64 Number of level-0 files that triggers a full write stop
Default: 256
rocksdb.limit-open-files-at-startup boolean Limit the amount of .sst files RocksDB will inspect at startup, in order to reduce startup IO
This option can be specified without value to enable it.
Default: false
Introduced in: v3.4.5
rocksdb.max-background-jobs int32 Maximum number of concurrent background jobs (compactions and flushes)
Default: dynamic (e.g. 36)
rocksdb.max-bytes-for-level-base uint64 If not using dynamic level sizes, this controls the maximum total data size for level-1
Default: 268435456
rocksdb.max-bytes-for-level-multiplier double If not using dynamic level sizes, the maximum number of bytes for level L can be calculated as max-bytes-for-level-base * (max-bytes-for-level-multiplier ^ (L-1))
Default: 10
rocksdb.max-parallel-compactions uint64 Maximum number of parallel compactions jobs
Default: 2
Introduced in: v3.7.11
rocksdb.max-subcompactions uint32 Maximum number of concurrent subjobs for a background compaction
Default: 2
rocksdb.max-total-wal-size uint64 Maximum total size of WAL files that will force flush stale column families
Default: 83886080
rocksdb.max-transaction-size uint64 Transaction size limit (in bytes)
Default: 18446744073709551615
rocksdb.max-write-buffer-number uint64 Maximum number of write buffers that build up in memory (default: number of column families + 2 = 9 write buffers). You can increase the amount only
Default: 10
rocksdb.max-write-buffer-number-definitions uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the definitions column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-number-documents uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the documents column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-number-edge uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the edge column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-number-fulltext uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the fulltext column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-number-geo uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the geo column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-number-primary uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the primary column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-number-replicated-logs uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the replicated-logs column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-number-vpack uint64 If non-zero, overrides the value of --rocksdb.max-write-buffer-number for the vpack column family
Default: 0
Introduced in: v3.8.0
rocksdb.max-write-buffer-size-to-maintain int64 Maximum size of immutable write buffers that build up in memory per column family (larger values mean that more in-memory data can be used for transaction conflict checking (-1 = use automatic default value, 0 = do not keep immutable flushed write buffers, which is the default and usually correct))
Default: 0
Introduced in: v3.7.3
rocksdb.min-write-buffer-number-to-merge uint64 Minimum number of write buffers that will be merged together before writing to storage
Default: dynamic (e.g. 1)
rocksdb.minimum-disk-free-bytes uint64 Minimum number of free disk bytes for considering the server healthy in health checks (set to 0 to disable the check)
Default: 16777216
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.0
rocksdb.minimum-disk-free-percent double Minimum percentage of free disk space for considering the server healthy in health checks (set to 0 to disable the check)
Default: 0.01
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.0
rocksdb.num-levels uint64 Number of levels for the database
Default: 7
rocksdb.num-threads-priority-high uint32 Number of threads for high priority operations (e.g. flush)
Default: 0
rocksdb.num-threads-priority-low uint32 Number of threads for low priority operations (e.g. compaction)
Default: 0
rocksdb.num-uncompressed-levels uint64 Number of uncompressed levels for the database
Default: 2
rocksdb.optimize-filters-for-hits boolean This flag specifies that the implementation should optimize the filters mainly for cases where keys are found rather than also optimize for keys missed. This would be used in cases where the application knows that there are very few misses or the performance in the case of misses is not important
This option can be specified without value to enable it.
Default: false
rocksdb.pending-compactions-slowdown-trigger uint64 Number of pending compaction bytes that triggers a write slowdown
Default: 131072
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.pending-compactions-stop-trigger uint64 Number of pending compaction bytes that triggers a full write stop
Default: 17179869184
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.pin-l0-filter-and-index-blocks-in-cache boolean If true and --rocksdb.cache-index-and-filter-blocks is also true, filter and index blocks are pinned and only evicted from cache when the table reader is freed
This option can be specified without value to enable it.
Default: false
Introduced in: v3.7.1
rocksdb.pin-top-level-index-and-filter boolean If true and --rocksdb.cache-index-and-filter-blocks is also true, the top-level index of partitioned filter and index blocks are pinned and only evicted from cache when the table reader is freed
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.1
rocksdb.recycle-log-file-num boolean If true, keep a pool of log files around for recycling
This option can be specified without value to enable it.
Default: false
rocksdb.sync-delay-threshold uint64 Threshold value for self-observation of WAL disk syncs. any WAL disk sync longer ago than this threshold will trigger a warning (in milliseconds, use 0 for no warnings)
Default: 5000
Effective on DB-Servers and Single Servers only.
Introduced in: v3.6.8, v3.7.5
rocksdb.sync-interval uint64 Interval for automatic, non-requested disk syncs (in milliseconds, use 0 to turn automatic syncing off)
Default: 100
Effective on DB-Servers and Single Servers only.
rocksdb.table-block-size uint64 Approximate size (in bytes) of user data packed per block
Default: 16384
rocksdb.target-file-size-base uint64 Per-file target file size for compaction (in bytes). the actual target file size for each level is --rocksdb.target-file-size-base multiplied by --rocksdb.target-file-size-multiplier ^ (level - 1)
Default: 67108864
Introduced in: v3.7.1
rocksdb.target-file-size-multiplier uint64 Multiplier for --rocksdb.target-file-size, a value of 1 means that files in different levels will have the same size
Default: 1
Introduced in: v3.7.1
rocksdb.throttle boolean Enable write-throttling
This option can be specified without value to enable it.
Default: true
Effective on DB-Servers and Single Servers only.
rocksdb.throttle-frequency uint64 Frequency for write-throttle calculations (in milliseconds)
Default: 1000
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.throttle-lower-bound-bps uint64 Lower bound for throttle’s write bandwidth in bytes per second
Default: 10485760
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.throttle-max-write-rate uint64 Maximum write rate enforced by throttle (in bytes per second, 0 = unlimited)
Default: 0
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.throttle-scaling-factor uint64 Adaptiveness scaling factor for write-throttle calculations
Default: 17
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.throttle-slots uint64 Number of historic metrics to use for throttle value calculation
Default: 120
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.throttle-slow-down-writes-trigger uint64 Number of level 0 files whose payload is not considered in throttle calculations when penalizing the presence of L0 files
Default: 8
Effective on DB-Servers and Single Servers only.
Introduced in: v3.8.5
rocksdb.total-write-buffer-size uint64 Maximum total size of in-memory write buffers (0 = unbounded)
Default: dynamic (e.g. 28596343603)
rocksdb.transaction-lock-stripes uint64 Number of lock stripes to use for transaction locks
Default: 36
Introduced in: v3.9.2
rocksdb.transaction-lock-timeout int64 If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a document. A negative value is not recommended as it can lead to deadlocks (0 = no waiting, < 0 no timeout)
Default: 1000
rocksdb.use-direct-io-for-flush-and-compaction boolean Use O_DIRECT for flush and compaction
This option can be specified without value to enable it.
Default: false
rocksdb.use-direct-reads boolean Use O_DIRECT for reading files
This option can be specified without value to enable it.
Default: false
rocksdb.use-file-logging boolean Use a file-base logger for RocksDB’s own logs
This option can be specified without value to enable it.
Default: false
rocksdb.use-fsync boolean Issue an fsync when writing to disk (set to true for issuing fdatasync only)
This option can be specified without value to enable it.
Default: false
rocksdb.use-range-delete-in-wal boolean Enable range delete markers in the write-ahead log (WAL). potentially incompatible with older arangosync versions
This option can be specified without value to enable it.
Default: true
Effective on DB-Servers only.
Introduced in: v3.10.0
rocksdb.wal-archive-size-limit uint64 Maximum total size (in bytes) of archived WAL files (0 = unlimited)
Default: 0
Effective on DB-Servers and Single Servers only.
rocksdb.wal-directory string Optional path to the RocksDB WAL directory. If not set, the WAL directory will be located inside the regular data directory
Default: ""
rocksdb.wal-file-timeout double Timeout after which unused WAL files are deleted
Default: 10
Effective on DB-Servers and Single Servers only.
rocksdb.wal-file-timeout-initial double Initial timeout after which unused WAL files deletion kicks in after server start
Default: 180
Effective on DB-Servers and Single Servers only.
rocksdb.wal-recovery-skip-corrupted boolean Skip corrupted records in WAL recovery
This option can be specified without value to enable it.
Default: false
rocksdb.write-buffer-size uint64 Amount of data to build up in memory before converting to a sorted on-disk file (0 = disabled)
Default: 67108864

Server

Also see Server details.

Name Type Description
server.allow-use-database boolean Allow change of database in REST actions, only needed for unittests
This option can be specified without value to enable it.
Default: false
server.authentication boolean Enable authentication for ALL client requests
This option can be specified without value to enable it.
Default: true
server.authentication-system-only boolean Use HTTP authentication only for requests to /_api and /_admin
This option can be specified without value to enable it.
Default: true
server.authentication-timeout double Timeout for the authentication cache in seconds (0 = indefinitely)
Default: 0
server.authentication-unix-sockets boolean Authentication for requests via UNIX domain sockets
This option can be specified without value to enable it.
Default: true
server.cluster-metrics-timeout uint32 Cluster metrics polling timeout in seconds
Default: 0
Introduced in: v31.0.0
server.descriptors-minimum uint64 Minimum number of file descriptors needed to start (0 = no minimum)
Default: 8192
server.endpoint string… Endpoint for client requests (e.g. ‘http+tcp://127.0.0.1:8529’, or ‘vst+ssl://192.168.1.1:8529’)
Default: ["tcp://0.0.0.0:8529"]
server.export-metrics-api boolean Turn metrics API on or off
This option can be specified without value to enable it.
Default: true
Introduced in: v3.6.0
server.export-read-write-metrics boolean Turn metrics for document read/write metrics on or off
This option can be specified without value to enable it.
Default: false
Introduced in: v3.7.7
server.gid string Switch to group-id after reading config files
Default: ""
server.harden boolean Lock down REST APIs that reveal version information or server internals for non-admin users
This option can be specified without value to enable it.
Default: false
Introduced in: v3.5.0
server.io-threads uint64 Number of threads used to handle IO
Default: dynamic (e.g. 9)
server.jwt-secret string Secret to use when doing jwt authentication
Default: ""
Deprecated in: v3.3.22, v3.4.2
server.jwt-secret-folder string Enterprise Edition only
Folder containing one or more jwt secret files to use for jwt authentication. Files are sorted alphabetically: First secret is used for signing + verifying JWT tokens. The latter secrets are only used for verifying.
Default: ""
Introduced in: v3.7.0
server.jwt-secret-keyfile string File containing jwt secret to use when doing jwt authentication.
Default: ""
server.local-authentication boolean Enable authentication using the local user database
This option can be specified without value to enable it.
Default: true
Effective on Coordinators and Single Servers only.
server.maintenance-actions-block int32 Minimum number of seconds finished Actions block duplicates
Default: 2
Effective on DB-Servers only.
server.maintenance-actions-linger int32 Minimum number of seconds finished Actions remain in deque
Default: 3600
Effective on DB-Servers only.
server.maintenance-slow-threads uint32 Maximum number of threads available for slow maintenance actions (long SynchronizeShard and long EnsureIndex)
Default: dynamic (e.g. 5)
Effective on DB-Servers only.
Introduced in: v3.8.3
server.maintenance-threads uint32 Maximum number of threads available for maintenance actions
Default: dynamic (e.g. 10)
Effective on DB-Servers only.
server.maximal-queue-size uint64 Size of the priority 3 fifo
Default: 4096
server.maximal-threads uint64 Maximum number of request handling threads to run (0 = use system-specific default of 72)
Default: dynamic (e.g. 0)
server.minimal-threads uint64 Minimum number of request handling threads to run
Default: 4
server.ongoing-low-priority-multiplier double Controls the number of low prio requests that can be ongoing at a given point in time, relative to the maximum number of request handling threads
Default: 4
Introduced in: v3.8.0
server.prio1-size uint64 Size of the priority 1 fifo
Default: 4096
server.prio2-size uint64 Size of the priority 2 fifo
Default: 4096
Introduced in: v3.8.0
server.rest-server boolean Start a rest-server
This option can be specified without value to enable it.
Default: true
server.scheduler-queue-size uint64 Number of simultaneously queued requests inside the scheduler
Default: 4096
server.session-timeout double Lifetime for tokens in seconds that can be obtained from the POST /_open/auth endpoint. Used by the web interface for JWT-based sessions
Default: 3600
Effective on Coordinators and Single Servers only.
Introduced in: v3.9.0
server.statistics boolean Turn statistics gathering and APIs on or off
This option can be specified without value to enable it.
Default: true
server.statistics-all-databases boolean Provide cluster statistics in web interface in all databases
This option can be specified without value to enable it.
Default: true
Effective on Coordinators only.
Introduced in: v3.8.0
server.statistics-history boolean Turn storing statistics in database on or off
This option can be specified without value to enable it.
Default: dynamic (e.g. true)
Introduced in: v3.4.9, v3.5.1
server.storage-engine string Storage engine type (note that the mmfiles engine is unavailable since v3.7.0 and cannot be used anymore)
Default: "auto"
Possible values: “auto”, “rocksdb”
server.support-info-api string Policy for exposing support info API
Default: "admin"
Possible values: “admin”, “disabled”, “jwt”, “public”
Introduced in: v3.9.0
server.uid string Switch to user-id after reading config files
Default: ""
server.unavailability-queue-fill-grade double Queue fill grade from which onwards the server is considered unavailable because of overload (ratio, use a value of 0 to disable it)
Default: 0.75
Introduced in: v3.6.10, v3.7.6
server.validate-utf8-strings boolean Perform UTF-8 string validation for incoming JSON and VelocyPack data
This option can be specified without value to enable it.
Default: true
Introduced in: v3.7.0

SSL

Also see SSL details.

Name Type Description
ssl.cafile string Ca file used for secure connections
Default: ""
ssl.cipher-list string Ssl ciphers to use, see OpenSSL documentation
Default: "HIGH:!EXPORT:!aNULL@STRENGTH"
ssl.ecdh-curve string SSL ECDH Curve, see the output of “openssl ecparam -list_curves”
Default: "prime256v1"
ssl.keyfile string Key-file used for secure connections
Default: ""
ssl.options uint64 Ssl connection options, see OpenSSL documentation
Default: 2147485780
ssl.prefer-http1-in-alpn boolean Allows to let the server prefer HTTP/1.1 over HTTP/2 in ALPN protocol negotiations
This option can be specified without value to enable it.
Default: false
ssl.protocol uint64 Ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS)
Default: 9
Possible values: 1, 2, 3, 4, 5, 6, 9
ssl.require-peer-certificate boolean Enterprise Edition only
Require a peer certificate when connecting
This option can be specified without value to enable it.
Default: false
ssl.server-name-indication string… Enterprise Edition only
Add a case SERVERNAME=KEYFILENAME for a different server keyfile for a specific server name, can be given multiple times
Default: []
ssl.session-cache boolean Enable the session cache for connections
This option can be specified without value to enable it.
Default: false

TCP

Also see TCP details.

Name Type Description
tcp.backlog-size uint64 Listen backlog size
Default: 64
tcp.reuse-address boolean Try to reuse TCP port(s)
This option can be specified without value to enable it.
Default: true

Temp

Also see Temp details.

Name Type Description
temp.path string Path for temporary files
Default: ""

Transaction

Also see Transaction details.

Name Type Description
transaction.streaming-idle-timeout double Idle timeout for streaming transactions in seconds
Default: 60
Effective on Coordinators and Single Servers only.
Introduced in: v3.8.0
transaction.streaming-lock-timeout double Lock timeout in seconds in case of parallel access to the same streaming transaction
Default: 8
Introduced in: v3.6.5, v3.7.1

TTL

Also see TTL details.

Name Type Description
ttl.frequency uint64 Frequency (in milliseconds) for the TTL background thread invocation. a value of 0 turns the TTL background thread off entirely
Default: 30000
ttl.max-collection-removes uint64 Maximum number of documents to remove per collection
Default: 1000000
ttl.max-total-removes uint64 Maximum number of documents to remove per invocation of the TTL thread
Default: 1000000
❮  ArangoDB Server

© ArangoDB - the native multi-model NoSQL database