ArangoDB Server Options

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

    Or explicitly as named parameter:

    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:

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

    See if you want to query the arangod server for the current settings at runtime.

    Also see General details.

    Agency

    Also see Agency details.

    NameTypeDescription
    agency.activatebooleanActivate agency
    This option can be specified without value to enable it.
    Default: false
    Effective on Agents only.
    agency.compaction-keep-sizeuint64Keep as many indices before compaction point
    Default: 50000
    Effective on Agents only.
    agency.compaction-step-sizeuint64Step size between state machine compactions
    Default: 1000
    Effective on Agents only.
    agency.disaster-recovery-idstringAllows for specification of the id for this agent; dangerous option for disaster recover only!
    Default: “”
    Effective on Agents only.
    agency.election-timeout-maxdoubleMaximum timeout before an agent calls for new election (in seconds)
    Default: 5
    Effective on Agents only.
    agency.election-timeout-mindoubleMinimum timeout before an agent calls for new election (in seconds)
    Default: 1
    Effective on Agents only.
    agency.endpointstring…Agency endpoints
    Default: []
    Effective on Agents only.
    agency.max-append-sizeuint64Maximum size of appendEntries document (# log entries)
    Default: 250
    Effective on Agents only.
    agency.my-addressstringWhich address to advertise to the outside
    Default: “”
    Effective on Agents only.
    agency.pool-sizeuint64Number of agent pool
    Default: 1
    Effective on Agents only.
    agency.sizeuint64Number of agents
    Default: 1
    Effective on Agents only.
    agency.supervisionbooleanPerform arangodb cluster supervision
    This option can be specified without value to enable it.
    Default: false
    Effective on Agents only.
    agency.supervision-frequencydoubleArangodb cluster supervision frequency (in seconds)
    Default: 1
    Effective on Agents only.
    agency.supervision-grace-perioddoubleSupervision time, after which a server is considered to have failed (in seconds)
    Default: 10
    Effective on Agents only.
    agency.supervision-ok-thresholddoubleSupervision time, after which a server is considered to be bad [s]
    Default: 5
    Effective on Agents only.
    agency.wait-for-syncbooleanWait 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.

    NameTypeDescription
    arangosearch.commit-threadsuint32Upper limit to the allowed number of commit threads (0 == autodetect)
    Default: 0
    Introduced in: v3.7.5
    arangosearch.commit-threads-idleuint32Upper limit to the allowed number of idle threads to use for commit tasks (0 == autodetect)
    Default: 0
    Introduced in: v3.7.5
    arangosearch.consolidation-threadsuint32Upper limit to the allowed number of consolidation threads (0 == autodetect)
    Default: 0
    Introduced in: v3.7.5
    arangosearch.consolidation-threads-idleuint32Upper limit to the allowed number of idle threads to use for consolidation tasks (0 == autodetect)
    Default: 0
    Introduced in: v3.7.5
    arangosearch.threadsuint32The exact number of threads to use for asynchronous tasks (0 == autodetect)
    Default: 0
    Deprecated in: v3.7.5
    arangosearch.threads-limituint32Upper 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.

    NameTypeDescription
    audit.hostnamestringEnterprise Edition only
    Hostname to use
    Default: “”
    audit.max-entry-lengthuint32Enterprise Edition only
    Maximum length of a log entry (in bytes)
    Default: 134217728
    Introduced in: v3.7.9
    audit.outputstring…Enterprise Edition only
    Audit destination(s)
    Default: []

    Backup

    Also see Backup details.

    NameTypeDescription
    backup.api-enabledstringWhether the backup api is enabled (true) or not (false), or only enabled for superuser JWT (jwt)
    Default: “true”
    backup.local-path-prefixstringThis option restricts any backup target to a given path prefix
    Default: “/“

    Cache

    NameTypeDescription
    cache.rebalancing-intervaluint64Microseconds between rebalancing attempts
    Default: 2000000
    cache.sizeuint64Size of cache in bytes
    Default: dynamic (e.g. 15268124672)

    Cluster

    Also see .

    NameTypeDescription
    cluster.agency-endpointstring…Agency endpoint to connect to
    Default: []
    Effective on Coordinators and DB-Servers only.
    cluster.create-waits-for-sync-replicationbooleanActive 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-factoruint32Default replication factor for non-system collections
    Default: 0
    Effective on Coordinators only.
    Introduced in: v3.6.0
    cluster.force-one-shardbooleanForce 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-timeoutdoubleAmount 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-shardsuint32Maximum number of shards when creating new collections (0 = unrestricted)
    Default: 1000
    Effective on Coordinators only.
    Introduced in: v3.5.1
    cluster.max-replication-factoruint32Maximum replication factor for new collections (0 = unrestricted)
    Default: 10
    Effective on Coordinators only.
    Introduced in: v3.6.0
    cluster.min-replication-factoruint32Minimum replication factor for new collections
    Default: 1
    Effective on Coordinators only.
    Introduced in: v3.6.0
    cluster.my-addressstringThis server’s endpoint (cluster internal)
    Default: “”
    Effective on Coordinators and DB-Servers only.
    cluster.my-advertised-endpointstringThis server’s advertised endpoint (e.g. external IP address or load balancer, optional)
    Default: “”
    Effective on Coordinators and DB-Servers only.
    cluster.my-rolestringThis server’s role
    Default: “”
    cluster.require-persisted-idbooleanIf 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-shutdownbooleanCreate 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.synchronous-replication-timeout-factordoubleAll synchronous replication timeouts are multiplied by this factor
    Default: 1
    cluster.synchronous-replication-timeout-minimumdoubleAll synchronous replication timeouts will be at least this value (in seconds)
    Default: 30
    cluster.synchronous-replication-timeout-per-4kdoubleAll synchronous replication timeouts are increased by this amount per 4096 bytes (in seconds)
    Default: 0.1
    cluster.system-replication-factoruint32Default replication factor for system collections
    Default: 2
    Effective on Coordinators only.
    cluster.upgradestringPerform 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-concernuint32Write concern used for writes to new collections
    Default: 1
    Effective on Coordinators only.
    Introduced in: v3.6.0

    Database

    Also see .

    NameTypeDescription
    database.auto-upgradebooleanPerform a database upgrade if necessary
    This option can be specified without value to enable it.
    Default: false
    database.check-versionbooleanChecks 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.directorystringPath to the database directory
    Default: “”
    database.force-sync-propertiesbooleanForce 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-errorsbooleanLoad collections even if datafiles may contain errors
    This option can be specified without value to enable it.
    Default: false
    database.init-databasebooleanInitializes an empty database
    This is a command, no value needs to be specified. The process terminates after executing the command.
    database.old-system-collectionsbooleanCreate and use deprecated system collection (_modules, _fishbowl)
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.6.8, v3.7.4
    Deprecated in: v3.8.0
    database.passwordstringInitial password of root user
    Default: “”
    database.required-directory-statestringRequired 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-adminbooleanResets 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.throw-collection-not-loaded-errorbooleanThrow an error when accessing a collection that is still loading
    This option can be specified without value to enable it.
    Default: false
    Deprecated in: v3.7.0
    database.upgrade-checkbooleanSkip a database upgrade
    This option can be specified without value to enable it.
    Default: true
    database.wait-for-syncbooleanDefault wait-for-sync behavior, can be overwritten when creating a collection
    This option can be specified without value to enable it.
    Default: false

    Foxx

    Also see .

    NameTypeDescription
    foxx.apibooleanEnables 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-startupbooleanEnsure all Foxx services are synchronized before completeing the boot sequence
    This option can be specified without value to enable it.
    Default: true
    Effective on Coordinators and Single Servers only.
    Introduced in: v3.7.5
    foxx.queuesbooleanEnable Foxx queues
    This option can be specified without value to enable it.
    Default: true
    Effective on Coordinators and Single Servers only.
    foxx.queues-poll-intervaldoublePoll interval (in seconds) for Foxx queue manager
    Default: 1
    Effective on Coordinators and Single Servers only.
    foxx.storebooleanEnables 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

    Also see Frontend details.

    HTTP

    Also see HTTP details.

    NameTypeDescription
    http.allow-method-overridebooleanAllow HTTP method override using special headers
    This option can be specified without value to enable it.
    Default: false
    http.hide-product-headerbooleanDo not expose “Server: ArangoDB” header in HTTP responses
    This option can be specified without value to enable it.
    Default: false
    http.keep-alive-timeoutdoubleKeep-alive timeout in seconds
    Default: 300
    http.permanently-redirect-rootbooleanIf 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-tostringRedirect of root URL
    Default: “/_admin/aardvark/index.html”
    Introduced in: v3.7.12
    http.trusted-originstring…Trusted origin URLs for CORS requests with credentials
    Default: []

    JavaScript

    Also see JavaScript details.

    NameTypeDescription
    javascript.allow-admin-executebooleanFor 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-controlbooleanAllow 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-testingbooleanAllow 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-pathstringDirectory for Foxx applications
    Default: “./js/apps”
    Effective on Coordinators and Single Servers only.
    javascript.copy-installationbooleanCopy 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.enabledbooleanEnable 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-blackliststring…Endpoints that cannot be connected to via @arangodb/request module in JavaScript actions if not whitelisted
    Default: []
    Effective on Coordinators and Single Servers only.
    Introduced in: v3.5.0
    javascript.endpoints-whiteliststring…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.environment-variables-blackliststring…Environment variables that will be inaccessible in JavaScript if not whitelisted
    Default: []
    Effective on Coordinators and Single Servers only.
    Introduced in: v3.5.0
    javascript.environment-variables-whiteliststring…Environment variables that will be accessible in JavaScript
    Default: []
    Effective on Coordinators and Single Servers only.
    Introduced in: v3.5.0
    javascript.files-whiteliststring…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-frequencydoubleJavaScript time-based garbage collection frequency (each x seconds)
    Default: 60
    Effective on Coordinators and Single Servers only.
    javascript.gc-intervaluint64JavaScript request-based garbage collection interval (each x requests)
    Default: 2000
    Effective on Coordinators and Single Servers only.
    javascript.hardenbooleanDisables 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-directorystring…Additional paths containing JavaScript modules
    Default: [“./enterprise/js”]
    Effective on Coordinators and Single Servers only.
    javascript.scriptstring…Run scripts and exit
    Default: []
    javascript.script-parameterstring…Script parameter
    Default: []
    javascript.startup-directorystringPath to the directory containing JavaScript startup scripts
    Default: “./js”
    Effective on Coordinators and Single Servers only.
    javascript.startup-options-blackliststring…Startup options whose names match this regular expression will not be exposed (if not whitelisted) to JavaScript actions
    Default: []
    Effective on Coordinators and Single Servers only.
    Introduced in: v3.5.0
    javascript.startup-options-whiteliststring…Startup options whose names match this regular expression will be whitelisted and exposed to JavaScript
    Default: []
    Effective on Coordinators and Single Servers only.
    Introduced in: v3.5.0
    javascript.v8-contextsuint64Maximum number of V8 contexts that are created for executing JavaScript actions
    Default: 0
    Effective on Coordinators and Single Servers only.
    javascript.v8-contexts-max-agedoubleMaximum age for each V8 context (in seconds) before it is disposed
    Default: 60
    Effective on Coordinators and Single Servers only.
    javascript.v8-contexts-max-invocationsuint64Maximum number of invocations for each V8 context before it is disposed
    Default: 0
    Effective on Coordinators and Single Servers only.
    javascript.v8-contexts-minimumuint64Minimum number of V8 contexts that keep available for executing JavaScript actions
    Default: 0
    Effective on Coordinators and Single Servers only.
    javascript.v8-max-heapuint64Maximal heap size (in MB)
    Default: 3072
    javascript.v8-optionsstring…Options to pass to v8
    Default: []

    LDAP

    Also see LDAP details.

    NameTypeDescription
    ldap.allow-offlinebooleanEnterprise 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-connectbooleanEnterprise 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.basednstringEnterprise Edition only
    Ldap basedn, eg. dc=example,dc=com
    Default: “”
    ldap.binddnstringEnterprise Edition only
    Ldap binddn, eg. cn=admin,dc=example,dc=com
    Default: “”
    ldap.bindpasswdstringEnterprise Edition only
    Ldap bindpassword, eg. admin
    Default: “”
    ldap.debugbooleanEnterprise 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
    booleanEnterprise Edition only
    Enable LDAP
    This option can be specified without value to enable it.
    Default: false
    ldap.network-timeoutdoubleEnterprise 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.portuint16Enterprise Edition only
    Port to use
    Default: 389
    ldap.prefixstringEnterprise Edition only
    Ldap prefix, eg. uid= xor dn= xor cn=
    Default: “”
    ldap.referralsbooleanEnterprise 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-ratedoubleEnterprise Edition only
    Refresh user settings after this time (in seconds)
    Default: 300
    ldap.responsible-forstringEnterprise 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.restartbooleanEnterprise 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.retriesuint32Enterprise 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-namestringEnterprise Edition only
    Ldap attributename where the role are located.
    Default: “”
    ldap.roles-excludestringEnterprise Edition only
    Regexp to exclude groups. Leave empty to exclude none.
    Default: “”
    ldap.roles-includestringEnterprise Edition only
    Regexp to include groups. Leave empty to include all.
    Default: “”
    ldap.roles-searchstringEnterprise Edition only
    Ldap search for roles; ‘{USER}’ is replaced by the ‘dn’ of the user.
    Default: “”
    ldap.roles-transformationstring…Enterprise Edition only
    Regexp to normalizer role name, e.g. ‘/^ (.[^ ]])/$2/’
    Default: []
    ldap.search-attributestringEnterprise Edition only
    Ldap search attribute, eg. uid
    Default: “uid”
    ldap.search-filterstringEnterprise Edition only
    Ldap search filter, eg. (objectClass=simpleSecurityObject)
    Default: “objectClass=“
    ldap.search-scopestringEnterprise Edition only
    Ldap search scope, one of base, one, sub
    Default: “sub”
    ldap.serialize-timeoutdoubleEnterprise Edition only
    Maximum amount of time (in seconds) that will be waited for the serialization mutex
    Default: 5
    ldap.serializedbooleanEnterprise 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.serverstringEnterprise Edition only
    Server to use
    Default: “”
    ldap.suffixstringEnterprise Edition only
    Ldap suffix, eg. ,dc=example,dc=com
    Default: “”
    ldap.superuser-rolestringEnterprise Edition only
    Role mapping to the super-users
    Default: “”
    ldap.timeoutdoubleEnterprise Edition only
    Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout)
    Default: 0
    ldap.tlsbooleanEnterprise Edition only
    Enable TLS
    This option can be specified without value to enable it.
    Default: false
    ldap.tls-cacert-dirstringEnterprise Edition only
    Ldap tls cacert dir
    Default: “”
    ldap.tls-cacert-filestringEnterprise Edition only
    Ldap tls cacert file
    Default: “”
    ldap.tls-cert-check-strategystringEnterprise Edition only
    Ldap tls cert check strategy, one of never, hard, demand, allow, try
    Default: “hard”
    ldap.tls-versionstringEnterprise Edition only
    Ldap tls version, one of 1.0, 1.1, 1.2
    Default: “1.2”
    ldap.urlstringEnterprise 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).

    NameTypeDescription
    ldap2.allow-offlinebooleanEnterprise 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-connectbooleanEnterprise 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.basednstringEnterprise Edition only
    Ldap basedn, eg. dc=example,dc=com
    Default: “”
    ldap2.binddnstringEnterprise Edition only
    Ldap binddn, eg. cn=admin,dc=example,dc=com
    Default: “”
    ldap2.bindpasswdstringEnterprise Edition only
    Ldap bindpassword, eg. admin
    Default: “”
    ldap2.debugbooleanEnterprise 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.enabledbooleanEnterprise Edition only
    Enable LDAP
    This option can be specified without value to enable it.
    Default: false
    ldap2.network-timeoutdoubleEnterprise 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.portuint16Enterprise Edition only
    Port to use
    Default: 389
    ldap2.prefixstringEnterprise Edition only
    Ldap prefix, eg. uid= xor dn= xor cn=
    Default: “”
    ldap2.referralsbooleanEnterprise 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-ratedoubleEnterprise Edition only
    Refresh user settings after this time (in seconds)
    Default: 300
    ldap2.responsible-forstringEnterprise 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.restartbooleanEnterprise 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.retriesuint32Enterprise 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-namestringEnterprise Edition only
    Ldap attributename where the role are located.
    Default: “”
    ldap2.roles-excludestringEnterprise Edition only
    Regexp to exclude groups. Leave empty to exclude none.
    Default: “”
    ldap2.roles-includestringEnterprise Edition only
    Regexp to include groups. Leave empty to include all.
    Default: “”
    ldap2.roles-searchstringEnterprise Edition only
    Ldap search for roles; ‘{USER}’ is replaced by the ‘dn’ of the user.
    Default: “”
    ldap2.roles-transformationstring…Enterprise Edition only
    Regexp to normalizer role name, e.g. ‘/^ (.[^ ]])/$2/’
    Default: []
    ldap2.search-attributestringEnterprise Edition only
    Ldap search attribute, eg. uid
    Default: “uid”
    ldap2.search-filterstringEnterprise Edition only
    Ldap search filter, eg. (objectClass=simpleSecurityObject)
    Default: “objectClass=“
    ldap2.search-scopestringEnterprise Edition only
    Ldap search scope, one of base, one, sub
    Default: “sub”
    ldap2.serialize-timeoutdoubleEnterprise Edition only
    Maximum amount of time (in seconds) that will be waited for the serialization mutex
    Default: 5
    ldap2.serializedbooleanEnterprise 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.serverstringEnterprise Edition only
    Server to use
    Default: “”
    ldap2.suffixstringEnterprise Edition only
    Ldap suffix, eg. ,dc=example,dc=com
    Default: “”
    ldap2.superuser-rolestringEnterprise Edition only
    Role mapping to the super-users
    Default: “”
    ldap2.timeoutdoubleEnterprise Edition only
    Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout)
    Default: 0
    ldap2.tlsbooleanEnterprise Edition only
    Enable TLS
    This option can be specified without value to enable it.
    Default: false
    ldap2.tls-cacert-dirstringEnterprise Edition only
    Ldap tls cacert dir
    Default: “”
    ldap2.tls-cacert-filestringEnterprise Edition only
    Ldap tls cacert file
    Default: “”
    ldap2.tls-cert-check-strategystringEnterprise Edition only
    Ldap tls cert check strategy, one of never, hard, demand, allow, try
    Default: “hard”
    ldap2.tls-versionstringEnterprise Edition only
    Ldap tls version, one of 1.0, 1.1, 1.2
    Default: “1.2”
    ldap2.urlstringEnterprise Edition only
    Ldap url, eg. ldap://example.com:389/dc=example,dc=com?uid?sub
    Default: “”

    Log

    Also see Log details.

    NameTypeDescription
    log.api-enabledstringWhether 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.colorbooleanUse colors for TTY logging
    This option can be specified without value to enable it.
    Default: dynamic (e.g. true)
    log.escapebooleanEscape characters when logging
    This option can be specified without value to enable it.
    Default: true
    log.filestringShortcut for ‘—log.output file://‘
    Default: “”
    log.file-groupstringGroup to use for new log file, user must be a member of this group
    Default: “”
    Introduced in: v3.4.5
    log.file-modestringMode to use for new log file, umask will be applied as well
    Default: “”
    Introduced in: v3.4.5
    log.force-directbooleanDo not start a seperate thread for logging
    This option can be specified without value to enable it.
    Default: false
    log.foreground-ttybooleanAlso log to tty if backgrounded
    This option can be specified without value to enable it.
    Default: dynamic (e.g. false)
    log.idsbooleanLog unique message ids
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.5.0
    log.in-memory-levelstringUse 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-logrotatebooleanKeep the old log file after receiving a sighup
    This option can be specified without value to enable it.
    Default: false
    log.levelstring…The global or topic-specific log level
    Default: [“info”,”info”]
    log.line-numberbooleanInclude 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-lengthuint32Maximum length of a log entry (in bytes)
    Default: 134217728
    Introduced in: v3.7.9
    log.outputstring…Log destination(s), e.g. file:///path/to/file (any ‘$PID’ will be replaced with the process id)
    Default: []
    log.performancebooleanShortcut for ‘—log.level performance=trace’
    This option can be specified without value to enable it.
    Default: false
    Deprecated in: v3.5.0
    log.prefixstringPrefix log message with this string
    Default: “”
    log.request-parametersbooleanInclude full URLs and HTTP request parameters in trace logs
    This option can be specified without value to enable it.
    Default: true
    log.rolebooleanLog server role
    This option can be specified without value to enable it.
    Default: false
    log.shorten-filenamesbooleanShorten filenames in log output (use with —log.line-number)
    This option can be specified without value to enable it.
    Default: true
    log.threadbooleanShow thread identifier in log message
    This option can be specified without value to enable it.
    Default: false
    log.thread-namebooleanShow thread name in log message
    This option can be specified without value to enable it.
    Default: false
    log.time-formatstringTime 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-local-timebooleanUse local timezone instead of UTC
    This option can be specified without value to enable it.
    Default: false
    Deprecated in: v3.5.0
    log.use-microtimebooleanUse microtime instead
    This option can be specified without value to enable it.
    Default: false
    Deprecated in: v3.5.0

    Network

    Also see Network details.

    NameTypeDescription
    network.idle-connection-ttluint64Default time-to-live of idle connections (in milliseconds)
    Default: 60000
    Effective on Coordinators, DB-Servers and Agents only.
    Introduced in: v3.6.0
    network.io-threadsuint32Number of network IO threads
    Default: 1
    Effective on Coordinators, DB-Servers and Agents only.
    Introduced in: v3.6.0
    network.max-open-connectionsuint64Max open network connections
    Default: 1024
    Effective on Coordinators, DB-Servers and Agents only.
    Introduced in: v3.6.0
    network.protocolstringNetwork protocol to use
    Default: “”
    Possible values: “”, “h2”, “http”, “http2”, “vst”
    Effective on Coordinators, DB-Servers and Agents only.
    Introduced in: v3.7.0
    network.verify-hostsbooleanVerify hosts when using TLS
    This option can be specified without value to enable it.
    Default: false
    Effective on Coordinators, DB-Servers and Agents only.
    Introduced in: v3.6.0

    Nonce

    NameTypeDescription
    nonce.sizeuint64The size of the hash array for nonces
    Default: 4194304

    Query

    Also see .

    NameTypeDescription
    query.cache-entriesuint64Maximum number of results in query result cache per database
    Default: 128
    query.cache-entries-max-sizeuint64Maximum cumulated size of results in query result cache per database
    Default: 268435456
    query.cache-entry-max-sizeuint64Maximum size of an invidiual result entry in query result cache
    Default: 16777216
    query.cache-include-system-collectionsbooleanWhether 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-modestringMode for the AQL query result cache (on, off, demand)
    Default: “off”
    query.fail-on-warningbooleanWhether AQL queries should fail with errors even for recoverable warnings
    This option can be specified without value to enable it.
    Default: false
    query.max-parallelismuint64Enterprise 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-runtimedoubleRuntime threshold for AQL queries (in seconds, 0 = no limit)
    Default: 0
    Introduced in: v3.6.7, v3.7.3
    query.memory-limituint64Memory threshold for AQL queries (in bytes, 0 = no limit)
    Default: 0
    query.optimizer-max-plansuint64Maximum number of query plans to create for a query
    Default: 128
    query.optimizer-rulesstring…Enable or disable specific optimizer rules (use rule name prefixed with ‘-‘ for disabling, ‘+’ for enabling)
    Default: []
    Introduced in: v3.6.0
    query.parallelize-gather-writesbooleanEnable write parallelization for gather nodes
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.6.0
    query.parallelize-traversalsbooleanEnterprise Edition only
    Enable traversal parallelization
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.7.1
    query.registry-ttldoubleDefault time-to-live of cursors and query snippets (in seconds); if <= 0, value will default to 30 for single-server instances or 600 for cluster instances
    Default: 0
    query.require-withbooleanWhether 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.7.12
    query.slow-streaming-thresholddoubleThreshold for slow streaming AQL queries (in seconds)
    Default: 10
    query.slow-thresholddoubleThreshold for slow AQL queries (in seconds)
    Default: 10
    query.smart-joinsbooleanEnterprise Edition only
    Enable SmartJoins query optimization
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.4.5
    query.trackingbooleanWhether to track queries
    This option can be specified without value to enable it.
    Default: true
    query.tracking-slow-queriesbooleanWhether to track slow queries
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.7.4
    query.tracking-with-bindvarsbooleanWhether to track bind vars with AQL queries
    This option can be specified without value to enable it.
    Default: true
    query.tracking-with-datasourcesbooleanWhether 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-querystringbooleanWhether to track the query string
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.7.4

    Also see Random details.

    Rclone

    Also see Rclone details.

    NameTypeDescription
    rclone.executablestringRclone executable used for up and download of backups
    Default: “”

    Replication

    Also see Replication details.

    NameTypeDescription
    replication.active-failoverbooleanEnable active-failover during asynchronous replication
    This option can be specified without value to enable it.
    Default: false
    booleanSwitch to enable or disable the automatic start of replication appliers
    This option can be specified without value to enable it.
    Default: true
    replication.automatic-failoverbooleanPlease use —replication.active-failover instead
    This option can be specified without value to enable it.
    Default: false
    replication.connect-timeoutdoubleDefault timeout value for replication connection attempts (in seconds)
    Default: 10
    Introduced in: v3.4.9, v3.5.4
    replication.max-parallel-tailing-invocationsuint64Maximum number of concurrently allowed WAL tailing invocations (0 = unlimited)
    Default: 0
    Introduced in: v3.5.0
    replication.quick-keys-limituint64Limit 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-timeoutdoubleDefault timeout value for replication requests (in seconds)
    Default: 600
    Introduced in: v3.4.9, v3.5.4
    replication.sync-by-revisionbooleanWhether 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.

    NameTypeDescription
    rocksdb.allow-fallocatebooleanIf 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-blocksbooleanIf 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-bitsint64Number of shard bits to use for block cache (use -1 for default value)
    Default: -1
    rocksdb.block-cache-sizeuint64Size of block cache in bytes
    Default: dynamic (e.g. 18321749606)
    rocksdb.cache-index-and-filter-blocksbooleanIf turned on, the RocksDB block cache quota will also include RocksDB memtable sizes
    This option can be specified without value to enable it.
    Default: false
    Introduced in: v3.7.1
    rocksdb.cache-index-and-filter-blocks-with-high-prioritybooleanIf 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-sizeuint64If 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-filesbooleanEnterprise Edition only
    Enable generation of sha256 files for each .sst file
    This option can be specified without value to enable it.
    Default: true
    rocksdb.debug-loggingbooleanTrue to enable rocksdb debug logging
    This option can be specified without value to enable it.
    Default: false
    rocksdb.delayed-write-rateuint64Limited 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-bytesbooleanIf 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-cachebooleanUse in-memory cache for edges
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.6.4
    rocksdb.enable-pipelined-writebooleanIf true, use a two stage write queue for WAL writes and memtable writes
    This option can be specified without value to enable it.
    Default: false
    rocksdb.enable-statisticsbooleanWhether or not RocksDB statistics should be turned on
    This option can be specified without value to enable it.
    Default: false
    rocksdb.encryption-gen-internal-keybooleanEnterprise 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-key-generatorstringEnterprise Edition only
    Program providing the encryption key on stdout. If set, encryption will be enabled.
    Default: “”
    rocksdb.encryption-key-rotationbooleanEnterprise 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-keyfilestringEnterprise Edition only
    File containing encryption key. If set, encryption will be enabled.
    Default: “”
    rocksdb.encryption-keyfolderstringEnterprise 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-limitbooleanIf true, strictly enforces the block cache size limit
    This option can be specified without value to enable it.
    Default: false
    rocksdb.exclusive-writesbooleanIf 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
    rocksdb.intermediate-commit-countuint64An intermediate commit will be performed automatically when this number of operations is reached in a transaction
    Default: 1000000
    rocksdb.intermediate-commit-sizeuint64An intermediate commit will be performed automatically when a transaction has accumulated operations of this size (in bytes)
    Default: 536870912
    rocksdb.level0-compaction-triggerint64Number of level-0 files that triggers a compaction
    Default: 2
    rocksdb.level0-slowdown-triggerint64Number of level-0 files that triggers a write slowdown
    Default: 20
    rocksdb.level0-stop-triggerint64Number of level-0 files that triggers a full write stall
    Default: 36
    rocksdb.limit-open-files-at-startupbooleanLimit the amount of .sst files RocksDB will inspect at startup, in order to startup reduce IO
    This option can be specified without value to enable it.
    Default: false
    Introduced in: v3.4.5
    rocksdb.max-background-jobsint32Maximum number of concurrent background jobs (compactions and flushes)
    Default: dynamic (e.g. 8)
    rocksdb.max-bytes-for-level-baseuint64If not using dynamic level sizes, this controls the maximum total data size for level-1
    Default: 268435456
    rocksdb.max-bytes-for-level-multiplierdoubleIf 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-compactionsuint64Maximum number of parallel compactions jobs
    Default: 2
    Introduced in: v3.8.0
    rocksdb.max-subcompactionsuint64Maximum number of concurrent subjobs for a background compaction
    Default: 1
    rocksdb.max-total-wal-sizeuint64Maximum total size of WAL files that will force flush stale column families
    Default: 83886080
    rocksdb.max-transaction-sizeuint64Transaction size limit (in bytes)
    Default: 18446744073709551615
    rocksdb.max-write-buffer-numberuint64Maximum 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: 9
    rocksdb.max-write-buffer-size-to-maintainint64Maximum 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-mergeuint64Minimum number of write buffers that will be merged together before writing to storage
    Default: 1
    rocksdb.num-levelsuint64Number of levels for the database
    Default: 7
    rocksdb.num-threads-priority-highuint32Number of threads for high priority operations (e.g. flush)
    Default: 0
    rocksdb.num-threads-priority-lowuint32Number of threads for low priority operations (e.g. compaction)
    Default: 0
    rocksdb.num-uncompressed-levelsuint64Number of uncompressed levels for the database
    Default: 2
    rocksdb.optimize-filters-for-hitsbooleanThis 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.pin-l0-filter-and-index-blocks-in-cachebooleanIf 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-filterbooleanIf 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-numbooleanIf 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-thresholduint64Threshold 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 only.
    Introduced in: v3.6.8, v3.7.5
    rocksdb.sync-intervaluint64Interval for automatic, non-requested disk syncs (in milliseconds, use 0 to turn automatic syncing off)
    Default: 100
    Effective on DB-Servers only.
    rocksdb.table-block-sizeuint64Approximate size (in bytes) of user data packed per block
    Default: 16384
    rocksdb.target-file-size-baseuint64Per-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-multiplieruint64Multiplier 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.throttlebooleanEnable write-throttling
    This option can be specified without value to enable it.
    Default: true
    rocksdb.total-write-buffer-sizeuint64Maximum total size of in-memory write buffers (0 = unbounded)
    Default: dynamic (e.g. 24428999475)
    rocksdb.transaction-lock-timeoutint64If 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-compactionbooleanUse O_DIRECT for flush and compaction
    This option can be specified without value to enable it.
    Default: false
    rocksdb.use-direct-readsbooleanUse O_DIRECT for reading files
    This option can be specified without value to enable it.
    Default: false
    rocksdb.use-file-loggingbooleanUse a file-base logger for RocksDB’s own logs
    This option can be specified without value to enable it.
    Default: false
    rocksdb.use-fsyncbooleanIssue 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.wal-archive-size-limituint64Maximum total size (in bytes) of archived WAL files (0 = unlimited)
    Default: 0
    rocksdb.wal-directorystringOptional path to the RocksDB WAL directory. If not set, the WAL directory will be located inside the regular data directory
    Default: “”
    rocksdb.wal-file-timeoutdoubleTimeout after which unused WAL files are deleted
    Default: 10
    rocksdb.wal-file-timeout-initialdoubleInitial timeout after which unused WAL files deletion kicks in after server start
    Default: 180
    rocksdb.wal-recovery-skip-corruptedbooleanSkip corrupted records in WAL recovery
    This option can be specified without value to enable it.
    Default: false
    rocksdb.write-buffer-sizeuint64Amount of data to build up in memory before converting to a sorted on-disk file (0 = disabled)
    Default: 67108864

    Server

    Also see Server details.

    NameTypeDescription
    server.allow-use-databasebooleanAllow change of database in REST actions, only needed for unittests
    This option can be specified without value to enable it.
    Default: false
    server.authenticationbooleanEnable authentication for ALL client requests
    This option can be specified without value to enable it.
    Default: true
    server.authentication-system-onlybooleanUse HTTP authentication only for requests to /_api and /_admin
    This option can be specified without value to enable it.
    Default: true
    server.authentication-timeoutdoubleTimeout for the authentication cache in seconds (0 = indefinitely)
    Default: 0
    server.authentication-unix-socketsbooleanAuthentication for requests via UNIX domain sockets
    This option can be specified without value to enable it.
    Default: true
    server.descriptors-minimumuint64Minimum number of file descriptors needed to start
    Default: 0
    server.endpointstring…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-apibooleanTurn 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-metricsbooleanTurn 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.flush-intervaluint64Interval (in microseconds) for flushing data
    Default: 1000000
    server.gidstringSwitch to group-id after reading config files
    Default: “”
    server.hardenbooleanLock 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-threadsuint64Number of threads used to handle IO
    Default: dynamic (e.g. 4)
    server.jwt-secretstringSecret to use when doing jwt authentication
    Default: “”
    Deprecated in: v3.3.22, v3.4.2
    server.jwt-secret-folderstringEnterprise 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-keyfilestringFile containing jwt secret to use when doing jwt authentication.
    Default: “”
    server.local-authenticationbooleanEnable authentication using the local user database
    This option can be specified without value to enable it.
    Default: true
    server.maintenance-actions-blockint32Minimum number of seconds finished Actions block duplicates
    Default: 2
    Effective on DB-Servers only.
    server.maintenance-actions-lingerint32Minimum number of seconds finished Actions remain in deque
    Default: 3600
    Effective on DB-Servers only.
    server.maintenance-threadsuint32Maximum number of threads available for maintenance actions
    Default: dynamic (e.g. 5)
    Effective on DB-Servers only.
    server.maximal-queue-sizeuint64Size of the priority 2 fifo
    Default: 4096
    server.maximal-threadsuint64Maximum number of request handling threads to run (0 = use system-specific default of 64)
    Default: dynamic (e.g. 0)
    server.minimal-threadsuint64Minimum number of request handling threads to run
    Default: 2
    server.prio1-sizeuint64Size of the priority 1 fifo
    Default: 4096
    server.rest-serverbooleanStart a rest-server
    This option can be specified without value to enable it.
    Default: true
    server.scheduler-queue-sizeuint64Number of simultaneously queued requests inside the scheduler
    Default: 4096
    server.statisticsbooleanTurn statistics gathering/aggregation and APIs on or off
    This option can be specified without value to enable it.
    Default: true
    server.statistics-all-databasesbooleanProvide 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.7.9
    server.statistics-historybooleanTurn storing statistics in database on or off
    This option can be specified without value to enable it.
    Default: true
    Introduced in: v3.4.9, v3.5.1
    server.storage-enginestringStorage 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.uidstringSwitch to user-id after reading config files
    Default: “”
    server.unavailability-queue-fill-gradedoubleQueue fill grade from which onwards the server is considered unavailable because of overload (ratio, use a value of 0 to disable it)
    Default: 1
    Introduced in: v3.6.10, v3.7.6
    server.validate-utf8-stringsbooleanPerform 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.

    NameTypeDescription
    ssl.cafilestringCa file used for secure connections
    Default: “”
    ssl.cipher-liststringSsl ciphers to use, see OpenSSL documentation
    Default: “HIGH:!EXPORT:!aNULL@STRENGTH”
    ssl.ecdh-curvestringSSL ECDH Curve, see the output of “openssl ecparam -list_curves”
    Default: “prime256v1”
    ssl.keyfilestringKey-file used for secure connections
    Default: “”
    ssl.optionsuint64Ssl connection options, see OpenSSL documentation
    Default: 2147485780
    ssl.prefer-http1-in-alpnbooleanAllows 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.protocoluint64Ssl 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-certificatebooleanEnterprise Edition only
    Require a peer certificate when connecting
    This option can be specified without value to enable it.
    Default: false
    ssl.server-name-indicationstring…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-cachebooleanEnable the session cache for connections
    This option can be specified without value to enable it.
    Default: false

    TCP

    Also see TCP details.

    NameTypeDescription
    tcp.backlog-sizeuint64Listen backlog size
    Default: 64
    tcp.reuse-addressbooleanTry to reuse TCP port(s)
    This option can be specified without value to enable it.
    Default: true

    Temp

    Also see Temp details.

    NameTypeDescription
    temp.pathstringPath for temporary files
    Default: “”

    Transaction

    Also see Transaction details.

    NameTypeDescription
    transaction.streaming-lock-timeoutdoubleLock timeout in seconds in case of parallel access to the same streaming transaction
    Default: 8
    Introduced in: v3.6.5, v3.7.1