ArangoDB Server Options

Usage: arangod [<options>]

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

  1. arangod /path/to/datadir

Or explicitly as named parameter:

  1. 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 andfinally the parameter value. The value needs to be wrapped in double quote marksif the value contains whitespace. Extra whitespace around = is allowed:

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

See Configurationif you want to translate startup parameters to configuration filesor learn more about startup options in general.

SeeFetch Current Configuration Optionsif you want to query the arangod server for the current settings at runtime.

Global

Also see Global details.

NameTypeDescription
check-configurationbooleanCheck the configuration and exitThis is a command, no value needs to be specified. The process terminates after executing the command.
configstringThe configuration file or ‘none’Default: ""
configurationstringThe configuration file or ‘none’Default: ""
consolebooleanStart a JavaScript emergency consoleThis option can be specified without value to enable it.Default: false
daemonbooleanBackground the server, running it as daemonThis option can be specified without value to enable it.Default: false
default-languagestringISO-639 language codeDefault: ""
definestring…Define key=value for a @key@ entry in config fileDefault: []
dump-dependenciesbooleanDump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command.
dump-optionsbooleanDump configuration options in JSON formatThis is a command, no value needs to be specified. The process terminates after executing the command.
fortunebooleanShow fortune cookie on startupThis option can be specified without value to enable it.Default: false
gidstringSwitch to group-id after reading config filesDefault: ""
hundbooleanMake ArangoDB bark on startupThis option can be specified without value to enable it.Default: false
logstring…The global or topic-specific log levelDefault: ["info","info"]Deprecated in: v3.5.0
pid-filestringPid-file in daemon modeDefault: ""
supervisorbooleanBackground the server, starts a supervisorThis option can be specified without value to enable it.Default: false
uidstringSwitch to user-id after reading config filesDefault: ""
versionbooleanReports the version and exitsThis is a command, no value needs to be specified. The process terminates after executing the command.
working-directorystringWorking directory in daemon modeDefault: "/var/tmp"

Agency

Also see Agency details.

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

ArangoSearch

Also see ArangoSearch details.

NameTypeDescription
arangosearch.threadsuint64The exact number of threads to use for asynchronous tasks (0 == autodetect)Default: 0
arangosearch.threads-limituint64Upper limit to the autodetected number of threads to use for asynchronous tasks (0 == use default)Default: 0

Audit

Also see Audit details.

NameTypeDescription
audit.hostnamestring_Enterprise Edition only_Hostname to useDefault: ""
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 prefixDefault: "/"

Cache

Also see Cache details.

NameTypeDescription
cache.rebalancing-intervaluint64Microseconds between rebalancing attemptsDefault: 2000000
cache.sizeuint64Size of cache in bytesDefault: dynamic (e.g. 16341597184)

Cluster

Also see Cluster details.

NameTypeDescription
cluster.agency-endpointstring…Agency endpoint to connect toDefault: []
cluster.agency-prefixstringAgency prefixDefault: ""
cluster.create-waits-for-sync-replicationbooleanActive coordinator will wait for all replicas to create collectionThis option can be specified without value to enable it.Default: true
cluster.default-replication-factoruint32Default replication factor for non-system collectionsDefault: 0Introduced in: v3.6.0
cluster.force-one-shardbooleanForce one-shard mode for all new collectionsThis option can be specified without value to enable it.Default: falseIntroduced in: v3.6.0
cluster.index-create-timeoutdoubleAmount of time (in seconds) the coordinator will wait for an index to be created before giving upDefault: 3600
cluster.max-number-of-shardsuint32Maximum number of shards when creating new collections (0 = unrestricted)Default: 1000Introduced in: v3.5.1
cluster.max-replication-factoruint32Maximum replication factor for new collections (0 = unrestricted)Default: 10Introduced in: v3.6.0
cluster.min-replication-factoruint32Minimum replication factor for new collectionsDefault: 1Introduced in: v3.6.0
cluster.my-addressstringThis server’s endpoint (cluster internal)Default: ""
cluster.my-advertised-endpointstringThis server’s advertised endpoint (e.g. external IP address or load balancer, optional)Default: ""
cluster.my-rolestringThis server’s roleDefault: ""
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 startupThis option can be specified without value to enable it.Default: false
cluster.resign-leadership-on-shutdownbooleanCreate resign leader ship job for this dbsever on shutdownThis option can be specified without value to enable it.Default: false
cluster.synchronous-replication-timeout-factordoubleAll synchronous replication timeouts are multiplied by this factorDefault: 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 collectionsDefault: 2
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 collectionsDefault: 1Introduced in: v3.6.0

Compaction

Also see Compaction details.

NameTypeDescription
compaction.db-sleep-timedoubleSleep interval between two compaction runs (in s)Default: 1
compaction.dead-documents-thresholduint64Minimum unused count of documents in a datafileDefault: 16384
compaction.dead-size-percent-thresholddoubleHow many percent of the source datafile should be unused at leastDefault: 0.1
compaction.dead-size-thresholduint64How many bytes of the source data file are allowed to be unused at mostDefault: 131072
compaction.max-file-size-factoruint64How large the resulting file may be in comparison to the collections ‘—database.maximal-journal-size’ settingDefault: 3
compaction.max-filesuint64Maximum number of files to merge to one fileDefault: 3
compaction.max-result-file-sizeuint64How large may the compaction result file become (in bytes)Default: 134217728
compaction.min-intervaldoubleMinimum sleep time between two compaction runs (in s)Default: 10
compaction.min-small-data-file-sizeuint64Minimal filesize threshold original data files have to be below for a compactionDefault: 131072

Database

Also see Database details.

NameTypeDescription
database.auto-upgradebooleanPerform a database upgrade if necessaryThis option can be specified without value to enable it.Default: false
database.check-versionbooleanChecks the versions of the database and exitThis is a command, no value needs to be specified. The process terminates after executing the command.
database.directorystringPath to the database directoryDefault: ""
database.force-sync-propertiesbooleanForce syncing of collection properties to disk, will use waitForSync value of collection when turned offThis option can be specified without value to enable it.Default: true
database.ignore-datafile-errorsbooleanLoad collections even if datafiles may contain errorsThis option can be specified without value to enable it.Default: false
database.init-databasebooleanInitializes an empty databaseThis is a command, no value needs to be specified. The process terminates after executing the command.
database.maximal-journal-sizeuint64Default maximal journal size, can be overwritten when creating a collectionDefault: 33554432
database.passwordstringInitial password of root userDefault: ""
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 passwordThis 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 loadingThis option can be specified without value to enable it.Default: false
database.upgrade-checkbooleanSkip a database upgradeThis 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 collectionThis option can be specified without value to enable it.Default: false

Foxx

Also see Foxx details.

NameTypeDescription
foxx.apibooleanEnables Foxx management REST APIsThis option can be specified without value to enable it.Default: trueIntroduced in: v3.5.0
foxx.queuesbooleanEnable Foxx queuesThis option can be specified without value to enable it.Default: true
foxx.queues-poll-intervaldoublePoll interval (in seconds) for Foxx queue managerDefault: 1
foxx.storebooleanEnables Foxx store in web interfaceThis option can be specified without value to enable it.Default: trueIntroduced in: v3.5.0

Frontend

Also see Frontend details.

NameTypeDescription
frontend.proxy-request-checkbooleanEnable proxy request checkingThis option can be specified without value to enable it.Default: true
frontend.trusted-proxystring…List of proxies to trust (may be IP or network). Make sure —frontend.proxy-request-check is enabledDefault: []
frontend.version-checkbooleanAlert the user if new versions are availableThis option can be specified without value to enable it.Default: true

HTTP

Also see HTTP details.

NameTypeDescription
http.allow-method-overridebooleanAllow HTTP method override using special headersThis option can be specified without value to enable it.Default: false
http.hide-product-headerbooleanDo not expose “Server: ArangoDB” header in HTTP responsesThis option can be specified without value to enable it.Default: false
http.keep-alive-timeoutdoubleKeep-alive timeout in secondsDefault: 300
http.trusted-originstring…Trusted origin URLs for CORS requests with credentialsDefault: []

JavaScript

Also see JavaScript details.

NameTypeDescription
javascript.allow-admin-executebooleanFor testing purposes allow ‘_admin/execute’, NEVER enable on productionThis option can be specified without value to enable it.Default: false
javascript.allow-external-process-controlbooleanAllow execution and control of external processes from within JavaScript actionsThis option can be specified without value to enable it.Default: falseIntroduced in: v3.5.0
javascript.allow-port-testingbooleanAllow testing of ports from within JavaScript actionsThis option can be specified without value to enable it.Default: falseIntroduced in: v3.5.0
javascript.app-pathstringDirectory for Foxx applicationsDefault: "./js/apps"
javascript.copy-installationbooleanCopy contents of ‘javascript.startup-directory’ on first startThis option can be specified without value to enable it.Default: false
javascript.enabledbooleanEnable the V8 JavaScript engineThis option can be specified without value to enable it.Default: true
javascript.endpoints-blackliststring…Endpoints that cannot be connected to via @arangodb/request module in JavaScript actions if not whitelistedDefault: []Introduced in: v3.5.0
javascript.endpoints-whiteliststring…Endpoints that can be connected to via @arangodb/request module in JavaScript actionsDefault: []Introduced in: v3.5.0
javascript.environment-variables-blackliststring…Environment variables that will be inaccessible in JavaScript if not whitelistedDefault: []Introduced in: v3.5.0
javascript.environment-variables-whiteliststring…Environment variables that will be accessible in JavaScriptDefault: []Introduced in: v3.5.0
javascript.files-whiteliststring…Filesystem paths that will be accessible from within JavaScript actionsDefault: []Introduced in: v3.5.0
javascript.gc-frequencydoubleJavaScript time-based garbage collection frequency (each x seconds)Default: 60
javascript.gc-intervaluint64JavaScript request-based garbage collection interval (each x requests)Default: 2000
javascript.hardenbooleanDisables access to JavaScript functions in the internal module: getPid() and logLevel()This option can be specified without value to enable it.Default: falseIntroduced in: v3.5.0
javascript.module-directorystring…Additional paths containing JavaScript modulesDefault: ["./enterprise/js"]
javascript.scriptstring…Run scripts and exitDefault: []
javascript.script-parameterstring…Script parameterDefault: []
javascript.startup-directorystringPath to the directory containing JavaScript startup scriptsDefault: "./js"
javascript.startup-options-blackliststring…Startup options whose names match this regular expression will not be exposed (if not whitelisted) to JavaScript actionsDefault: []Introduced in: v3.5.0
javascript.startup-options-whiteliststring…Startup options whose names match this regular expression will be whitelisted and exposed to JavaScriptDefault: []Introduced in: v3.5.0
javascript.v8-contextsuint64Maximum number of V8 contexts that are created for executing JavaScript actionsDefault: 0
javascript.v8-contexts-max-agedoubleMaximum age for each V8 context (in seconds) before it is disposedDefault: 60
javascript.v8-contexts-max-invocationsuint64Maximum number of invocations for each V8 context before it is disposedDefault: 0
javascript.v8-contexts-minimumuint64Minimum number of V8 contexts that keep available for executing JavaScript actionsDefault: 0
javascript.v8-max-heapuint64Maximal heap size (in MB)Default: 3072
javascript.v8-optionsstring…Options to pass to v8Default: []

LDAP

Also see LDAP details.

NameTypeDescription
ldap.async-connectbooleanEnterprise Edition only_Whether or not the connection to the LDAP library will be done asynchronouslyThis option can be specified without value to enable it.Default: false
ldap.basednstring_Enterprise Edition only_Ldap basedn, eg. dc=example,dc=comDefault: ""
ldap.binddnstring_Enterprise Edition only_Ldap binddn, eg. cn=admin,dc=example,dc=comDefault: ""
ldap.bindpasswdstring_Enterprise Edition only_Ldap bindpassword, eg. adminDefault: ""
ldap.debugboolean_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.enabledboolean_Enterprise Edition only_Enable LDAPThis option can be specified without value to enable it.Default: false
ldap.network-timeoutdouble_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.portuint16_Enterprise Edition only_Port to useDefault: 389
ldap.prefixstring_Enterprise Edition only_Ldap prefix, eg. uid= xor dn= xor cn=Default: ""
ldap.referralsboolean_Enterprise Edition only_Whether or not the LDAP library should implicitly chase referralsThis option can be specified without value to enable it.Default: false
ldap.refresh-ratedouble_Enterprise Edition only_Refresh user settings after this time (in seconds)Default: 300
ldap.restartboolean_Enterprise Edition only_Whether or not the LDAP library should implicitly restart connectionsThis option can be specified without value to enable it.Default: false
ldap.retriesuint32_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 connectionDefault: 1
ldap.roles-attribute-namestring_Enterprise Edition only_Ldap attributename where the role are located.Default: ""
ldap.roles-excludestring_Enterprise Edition only_Regexp to exclude groups. Leave empty to exclude none.Default: ""
ldap.roles-includestring_Enterprise Edition only_Regexp to include groups. Leave empty to include all.Default: ""
ldap.roles-searchstring_Enterprise 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-attributestring_Enterprise Edition only_Ldap search attribute, eg. uidDefault: "uid"
ldap.search-filterstring_Enterprise Edition only_Ldap search filter, eg. (objectClass=simpleSecurityObject)Default: "objectClass="
ldap.search-scopestring_Enterprise Edition only_Ldap search scope, one of base, one, subDefault: "sub"
ldap.serialize-timeoutdouble_Enterprise Edition only_Maximum amount of time (in seconds) that will be waited for the serialization mutexDefault: 5
ldap.serializedboolean_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 functionalityThis option can be specified without value to enable it.Default: false
ldap.serverstring_Enterprise Edition only_Server to useDefault: ""
ldap.suffixstring_Enterprise Edition only_Ldap suffix, eg. ,dc=example,dc=comDefault: ""
ldap.superuser-rolestring_Enterprise Edition only_Role mapping to the super-usersDefault: ""
ldap.timeoutdouble_Enterprise Edition only_Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout)Default: 0
ldap.tlsboolean_Enterprise Edition only_Enable TLSThis option can be specified without value to enable it.Default: false
ldap.tls-cacert-dirstring_Enterprise Edition only_Ldap tls cacert dirDefault: ""
ldap.tls-cacert-filestring_Enterprise Edition only_Ldap tls cacert fileDefault: ""
ldap.tls-cert-check-strategystring_Enterprise Edition only_Ldap tls cert check strategy, one of never, hard, demand, allow, tryDefault: "hard"
ldap.tls-versionstring_Enterprise Edition only_Ldap tls version, one of 1.0, 1.1, 1.2Default: "1.2"
ldap.urlstring_Enterprise Edition only_Ldap url, eg. ldap://example.com:389/dc=example,dc=com?uid?subDefault: ""

Log

Also see Log details.

NameTypeDescription
log.colorbooleanUse colors for TTY loggingThis option can be specified without value to enable it.Default: dynamic (e.g. true)
log.escapebooleanEscape characters when loggingThis option can be specified without value to enable it.Default: true
log.filestringShortcut for ‘—log.output file://'Default: &#34;&#34;
log.file-groupstringGroup to use for new log file, user must be a member of this groupDefault: ""Introduced in: v3.4.5, v3.5.0
log.file-modestringMode to use for new log file, umask will be applied as wellDefault: ""Introduced in: v3.4.5, v3.5.0
log.force-directbooleanDo not start a seperate thread for loggingThis option can be specified without value to enable it.Default: false
log.foreground-ttybooleanAlso log to tty if backgroundedThis option can be specified without value to enable it.Default: dynamic (e.g. false)
log.idsbooleanLog unique message idsThis option can be specified without value to enable it.Default: trueIntroduced in: v3.5.0
log.keep-logrotatebooleanKeep the old log file after receiving a sighupThis option can be specified without value to enable it.Default: false
log.levelstring…The global or topic-specific log levelDefault: ["info","info"]
log.line-numberbooleanAppend line number and file nameThis option can be specified without value to enable it.Default: false
log.outputstring…Log destination(s), e.g. file:///path/to/file (Linux, macOS) or file://C:\path\to\file (Windows)Default: []
log.performancebooleanShortcut for ‘—log.level performance=trace’This option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.prefixstringPrefix log message with this stringDefault: ""
log.request-parametersbooleanInclude full URLs and HTTP request parameters in trace logsThis option can be specified without value to enable it.Default: true
log.rolebooleanLog server roleThis 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 messageThis option can be specified without value to enable it.Default: false
log.thread-namebooleanShow thread name in log messageThis option can be specified without value to enable it.Default: false
log.time-formatstringTime format to use in logsDefault: "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 UTCThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.use-microtimebooleanUse microtime insteadThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0

Network

Also see Network details.

NameTypeDescription
network.idle-connection-ttluint64Default time-to-live of idle connections (in milliseconds)Default: 60000Introduced in: v3.6.0
network.io-threadsuint32Number of network IO threadsDefault: 2Introduced in: v3.6.0
network.max-open-connectionsuint64Max open network connectionsDefault: 1024Introduced in: v3.6.0
network.verify-hostsbooleanVerify hosts when using TLSThis option can be specified without value to enable it.Default: falseIntroduced in: v3.6.0

Nonce

Also see Nonce details.

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

Query

Also see Query details.

NameTypeDescription
query.cache-entriesuint64Maximum number of results in query result cache per databaseDefault: 128
query.cache-entries-max-sizeuint64Maximum cumulated size of results in query result cache per databaseDefault: 268435456
query.cache-entry-max-sizeuint64Maximum size of an invidiual result entry in query result cacheDefault: 16777216
query.cache-include-system-collectionsbooleanWhether or not to include system collection queries in the query result cacheThis 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 warningsThis option can be specified without value to enable it.Default: false
query.memory-limituint64Memory threshold for AQL queries (in bytes)Default: 0
query.optimizer-max-plansuint64Maximum number of query plans to create for a queryDefault: 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 nodesThis option can be specified without value to enable it.Default: trueIntroduced in: v3.6.0
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 instancesDefault: 0
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-joinsboolean_Enterprise Edition only_Enable smart joins query optimizationThis option can be specified without value to enable it.Default: trueIntroduced in: v3.4.5, v3.5.0
query.trackingbooleanWhether to track slow AQL queriesThis option can be specified without value to enable it.Default: true
query.tracking-with-bindvarsbooleanWhether to track bind vars with AQL queriesThis option can be specified without value to enable it.Default: true

Random

Also see Random details.

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

Rclone

Also see Rclone details.

NameTypeDescription
rclone.executablestringRclone executable used for up and download of backupsDefault: ""

Replication

Also see Replication details.

NameTypeDescription
replication.active-failoverbooleanEnable active-failover during asynchronous replicationThis option can be specified without value to enable it.Default: false
replication.auto-startbooleanSwitch to enable or disable the automatic start of replication appliersThis option can be specified without value to enable it.Default: true
replication.automatic-failoverbooleanPlease use —replication.active-failover insteadThis option can be specified without value to enable it.Default: false
replication.connect-timeoutdoubleDefault timeout value for replication connection attempts (in seconds)Default: 10Introduced in: v3.4.9, v3.5.4
replication.max-parallel-tailing-invocationsuint64Maximum number of concurrently allowed WAL tailing invocations (0 = unlimited)Default: 0Introduced in: v3.5.0
replication.request-timeoutdoubleDefault timeout value for replication requests (in seconds)Default: 600Introduced in: v3.4.9, v3.5.4

RocksDB

Also see RocksDB details.

NameTypeDescription
rocksdb.allow-fallocatebooleanIf true, allow RocksDB to use fallocate calls. if false, fallocate calls are bypassedThis option can be specified without value to enable it.Default: trueIntroduced in: v3.4.5, v3.5.0
rocksdb.block-align-data-blocksbooleanIf true, aligns data blocks on lesser of page size and block sizeThis 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 bytesDefault: dynamic (e.g. 19609916620)
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 fileThis option can be specified without value to enable it.Default: true
rocksdb.debug-loggingbooleanTrue to enable rocksdb debug loggingThis 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 writesDefault: 0
rocksdb.dynamic-level-bytesbooleanIf true, determine the number of bytes for each level dynamically to minimize space amplificationThis option can be specified without value to enable it.Default: true
rocksdb.enable-pipelined-writebooleanIf true, use a two stage write queue for WAL writes and memtable writesThis option can be specified without value to enable it.Default: false
rocksdb.enable-statisticsbooleanWhether or not RocksDB statistics should be turned onThis option can be specified without value to enable it.Default: false
rocksdb.encryption-key-generatorstring_Enterprise Edition only_Program providing the encryption key on stdout. If set, encryption will be enabled.Default: ""
rocksdb.encryption-keyfilestring_Enterprise Edition only_File containing encryption key. If set, encryption will be enabled.Default: ""
rocksdb.enforce-block-cache-size-limitbooleanIf true, strictly enforces the block cache size limitThis 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 MMFiles collection locks behavior, but will inhibit concurrent write operationsThis option can be specified without value to enable it.Default: falseIntroduced in: v3.5.4
rocksdb.intermediate-commit-countuint64An intermediate commit will be performed automatically when this number of operations is reached in a transactionDefault: 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 compactionDefault: 2
rocksdb.level0-slowdown-triggerint64Number of level-0 files that triggers a write slowdownDefault: 20
rocksdb.level0-stop-triggerint64Number of level-0 files that triggers a full write stallDefault: 36
rocksdb.limit-open-files-at-startupbooleanLimit the amount of .sst files RocksDB will inspect at startup, in order to startup reduce IOThis option can be specified without value to enable it.Default: falseIntroduced in: v3.4.5, v3.5.0
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-1Default: 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-subcompactionsuint64Maximum number of concurrent subjobs for a background compactionDefault: 1
rocksdb.max-total-wal-sizeuint64Maximum total size of WAL files that will force flush stale column familiesDefault: 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 onlyDefault: 9
rocksdb.min-write-buffer-number-to-mergeuint64Minimum number of write buffers that will be merged together before writing to storageDefault: 1
rocksdb.num-levelsuint64Number of levels for the databaseDefault: 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 databaseDefault: 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 importantThis option can be specified without value to enable it.Default: false
rocksdb.recycle-log-file-numbooleanIf true, keep a pool of log files around for recyclingThis option can be specified without value to enable it.Default: false
rocksdb.sync-intervaluint64Interval for automatic, non-requested disk syncs (in milliseconds, use 0 to turn automatic syncing off)Default: 100
rocksdb.table-block-sizeuint64Approximate size (in bytes) of user data packed per blockDefault: 16384
rocksdb.throttlebooleanEnable write-throttlingThis 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. 26146555494)
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 compactionThis option can be specified without value to enable it.Default: false
rocksdb.use-direct-readsbooleanUse O_DIRECT for reading filesThis option can be specified without value to enable it.Default: false
rocksdb.use-file-loggingbooleanUse a file-base logger for RocksDB’s own logsThis 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 directoryDefault: ""
rocksdb.wal-file-timeoutdoubleTimeout after which unused WAL files are deletedDefault: 10
rocksdb.wal-file-timeout-initialdoubleInitial timeout after which unused WAL files deletion kicks in after server startDefault: 180
rocksdb.wal-recovery-skip-corruptedbooleanSkip corrupted records in WAL recoveryThis 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 unittestsThis option can be specified without value to enable it.Default: false
server.authenticationbooleanEnable authentication for ALL client requestsThis option can be specified without value to enable it.Default: true
server.authentication-system-onlybooleanUse HTTP authentication only for requests to /api and /_adminThis 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 socketsThis option can be specified without value to enable it.Default: true
server.check-max-memory-mappingsbooleanCheck the maximum number of memory mappings at runtimeThis option can be specified without value to enable it.Default: true
server.descriptors-minimumuint64Minimum number of file descriptors needed to startDefault: 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 offThis option can be specified without value to enable it.Default: true
server.flush-intervaluint64Interval (in microseconds) for flushing dataDefault: 1000000
server.gidstringSwitch to group-id after reading config filesDefault: ""
server.hardenbooleanLock down REST APIs that reveal version information or server internals for non-admin usersThis option can be specified without value to enable it.Default: falseIntroduced in: v3.5.0
server.io-threadsuint64Number of threads used to handle IODefault: _dynamic (e.g. 8)
server.jwt-secretstringSecret to use when doing jwt authenticationDefault: ""Deprecated in: v3.3.22, v3.4.2
server.jwt-secret-keyfilestringFile containing jwt secret to use when doing jwt authentication.Default: ""
server.local-authenticationbooleanEnable authentication using the local user databaseThis option can be specified without value to enable it.Default: true
server.maintenance-actions-blockint32Minimum number of seconds finished Actions block duplicatesDefault: 2
server.maintenance-actions-lingerint32Minimum number of seconds finished Actions remain in dequeDefault: 3600
server.maintenance-threadsuint32Maximum number of threads available for maintenance actionsDefault: dynamic (e.g. 9)
server.maximal-queue-sizeuint64Size of the priority 2 fifoDefault: 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 runDefault: 2
server.prio1-sizeuint64Size of the priority 1 fifoDefault: 4096
server.rest-serverbooleanStart a rest-serverThis option can be specified without value to enable it.Default: true
server.scheduler-queue-sizeuint64Number of simultaneously queued requests inside the schedulerDefault: 4096
server.statisticsbooleanTurn statistics gathering on or offThis option can be specified without value to enable it.Default: true
server.statistics-historybooleanTurn storing statistics in database on or offThis option can be specified without value to enable it.Default: trueIntroduced in: v3.4.9, v3.5.1
server.storage-enginestringStorage engine typeDefault: "auto"Possible values: “auto”, “mmfiles”, “rocksdb”
server.uidstringSwitch to user-id after reading config filesDefault: ""

SSL

Also see SSL details.

NameTypeDescription
ssl.cafilestringCa file used for secure connectionsDefault: ""
ssl.cipher-liststringSsl ciphers to use, see OpenSSL documentationDefault: "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 connectionsDefault: ""
ssl.optionsuint64Ssl connection options, see OpenSSL documentationDefault: 2147485780
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: 9Possible values: 1, 2, 3, 4, 5, 6, 9
ssl.require-peer-certificateboolean_Enterprise Edition only_Require a peer certificate when connectingThis option can be specified without value to enable it.Default: false
ssl.session-cachebooleanEnable the session cache for connectionsThis option can be specified without value to enable it.Default: false

TCP

Also see TCP details.

NameTypeDescription
tcp.backlog-sizeuint64Listen backlog sizeDefault: 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 filesDefault: ""

TTL

Also see TTL details.

NameTypeDescription
ttl.frequencyuint64Frequency (in milliseconds) for the TTL background thread invocation. a value of 0 turns the TTL background thread off entirelyDefault: 30000
ttl.max-collection-removesuint64Maximum number of documents to remove per collectionDefault: 1000000
ttl.max-total-removesuint64Maximum number of documents to remove per invocation of the TTL threadDefault: 1000000
ttl.only-loaded-collectionbooleanOnly consider already loaded collections for removalThis option can be specified without value to enable it.Default: true

WAL

Also see WAL details.

NameTypeDescription
wal.allow-oversize-entriesbooleanAllow entries that are bigger than ‘—wal.logfile-size’This option can be specified without value to enable it.Default: true
wal.directorystringLogfile directoryDefault: ""
wal.flush-timeoutuint64Flush timeout (in milliseconds)Default: 15000
wal.historic-logfilesuint32Maximum number of historic logfiles to keep after collectionDefault: 10
wal.ignore-logfile-errorsbooleanIgnore logfile errors. this will read recoverable data from corrupted logfiles but ignore any unrecoverable dataThis option can be specified without value to enable it.Default: false
wal.ignore-recovery-errorsbooleanContinue recovery even if re-applying operations failsThis option can be specified without value to enable it.Default: false
wal.logfile-sizeuint32Size of each logfile (in bytes)Default: 33554432
wal.open-logfilesuint32Maximum number of parallel open logfilesDefault: 0
wal.reserve-logfilesuint32Maximum number of reserve logfiles to maintainDefault: 3
wal.slotsuint32Number of logfile slots to useDefault: 1048576
wal.sync-intervaluint64Interval for automatic, non-requested disk syncs (in milliseconds)Default: 100
wal.throttle-waituint64Maximum wait time per operation when write-throttled (in milliseconds)Default: 15000
wal.throttle-when-pendinguint64Throttle writes when at least this many operations are waiting for collection (set to 0 to deactivate write-throttling)Default: 0
wal.use-mlockbooleanMlock WAL logfiles in memory (may require elevated privileges or limits)This option can be specified without value to enable it.Default: false