ArangoDB Server Options

Usage: arangod [<options>]

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

arangod /path/to/datadir

Or explicitly as named parameter:

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

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

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

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

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

Global

Also see Global details.

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

Agency

Also see Agency details.

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

Arangosearch

Also see Arangosearch details.

Name Type Description
arangosearch.threads uint64 The exact number of threads to use for asynchronous tasks (0 == autodetect)
Default: 0
arangosearch.threads-limit uint64 Upper limit to the autodetected number of threads to use for asynchronous tasks (0 == use default)
Default: 0

Audit

Also see Audit details.

Name Type Description
audit.hostname string Enterprise Edition only
Hostname to use
Default: ""
audit.output string… Enterprise Edition only
Audit destination(s)
Default: []

Cache

Also see Cache details.

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

Cluster

Also see Cluster details.

Name Type Description
cluster.agency-endpoint string… Agency endpoint to connect to
Default: []
cluster.agency-prefix string Agency prefix
Default: ""
cluster.create-waits-for-sync-replication boolean Active coordinator will wait for all replicas to create collection
This option can be specified without value to enable it.
Default: true
cluster.index-create-timeout double Amount of time (in seconds) the coordinator will wait for an index to be created before giving up
Default: 3600
cluster.my-address string This server’s endpoint (cluster internal)
Default: ""
cluster.my-advertised-endpoint string This server’s advertised endpoint (e.g. external ip address or load balancer, optional)
Default: ""
cluster.my-role string This server’s role
Default: ""
cluster.require-persisted-id boolean If set to true, then the instance will only start if a uuid file is found in the database on startup. setting this option will make sure the instance is started using an already existing database directory and not a new one. for the first start, the uuid file must either be created manually or the option must be set to false for the initial startup
This option can be specified without value to enable it.
Default: false
cluster.resign-leadership-on-shutdown boolean Create resign leader ship job for this dbsever on shutdown
This option can be specified without value to enable it.
Default: false
cluster.synchronous-replication-timeout-factor double All synchronous replication timeouts are multiplied by this factor
Default: 1
cluster.synchronous-replication-timeout-per-4k double All synchronous replication timeouts are increased by this amount per 4096 bytes (in seconds)
Default: 0.1
cluster.system-replication-factor uint32 Replication factor for system collections
Default: 2

Compaction

Also see Compaction details.

Name Type Description
compaction.db-sleep-time double Sleep interval between two compaction runs (in s)
Default: 1
compaction.dead-documents-threshold uint64 Minimum unused count of documents in a datafile
Default: 16384
compaction.dead-size-percent-threshold double How many percent of the source datafile should be unused at least
Default: 0.1
compaction.dead-size-threshold uint64 How many bytes of the source data file are allowed to be unused at most
Default: 131072
compaction.max-file-size-factor uint64 How large the resulting file may be in comparison to the collections ‘--database.maximal-journal-size’ setting
Default: 3
compaction.max-files uint64 Maximum number of files to merge to one file
Default: 3
compaction.max-result-file-size uint64 How large may the compaction result file become (in bytes)
Default: 134217728
compaction.min-interval double Minimum sleep time between two compaction runs (in s)
Default: 10
compaction.min-small-data-file-size uint64 Minimal filesize threshhold original data files have to be below for a compaction
Default: 131072

Database

Also see Database details.

Name Type Description
database.auto-upgrade boolean Perform a database upgrade if necessary
This option can be specified without value to enable it.
Default: false
database.check-version boolean Checks the versions of the database and exit
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
database.directory string Path to the database directory
Default: ""
database.force-sync-properties boolean Force syncing of collection properties to disk, will use waitforsync value of collection when turned off
This option can be specified without value to enable it.
Default: true
database.ignore-datafile-errors boolean Load collections even if datafiles may contain errors
This option can be specified without value to enable it.
Default: false
database.init-database boolean Initializes an empty database
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
database.maximal-journal-size uint64 Default maximal journal size, can be overwritten when creating a collection
Default: 33554432
database.password string Initial password of root user
Default: ""
database.required-directory-state string Required state of database directory at startup (non-existing: database directory must not exist, existing: database directory must exist, empty: database directory must exist but be empty, populated: database directory must exist and contain specific files already, any: any state allowed)
Default: "any"
Possible values: “any”, “empty”, “existing”, “non-existing”, “populated”
database.restore-admin boolean Resets the admin users and sets a new password
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
database.throw-collection-not-loaded-error boolean Throw an error when accessing a collection that is still loading
This option can be specified without value to enable it.
Default: false
database.upgrade-check boolean Skip a database upgrade
This option can be specified without value to enable it.
Default: true
database.wait-for-sync boolean Default wait-for-sync behavior, can be overwritten when creating a collection
This option can be specified without value to enable it.
Default: false

Foxx

Also see Foxx details.

Name Type Description
foxx.api boolean Enables foxx management rest apis
This option can be specified without value to enable it.
Default: true
Introduced in: v3.5.0
foxx.queues boolean Enable foxx queues
This option can be specified without value to enable it.
Default: true
foxx.queues-poll-interval double Poll interval (in seconds) for foxx queue manager
Default: 1
foxx.store boolean Enables foxx store in web interface
This option can be specified without value to enable it.
Default: true
Introduced in: v3.5.0

Frontend

Also see Frontend details.

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

Http

Also see Http details.

Name Type Description
http.allow-method-override boolean Allow http method override using special headers
This option can be specified without value to enable it.
Default: false
http.hide-product-header boolean Do not expose “server: arangodb” header in http responses
This option can be specified without value to enable it.
Default: false
http.keep-alive-timeout double Keep-alive timeout in seconds
Default: 300
http.trusted-origin string… Trusted origin urls for cors requests with credentials
Default: []

Javascript

Also see Javascript details.

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

Ldap

Also see Ldap details.

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

Log

Also see Log details.

Name Type Description
log.color boolean Use colors for tty logging
This option can be specified without value to enable it.
Default: true
log.escape boolean Escape characters when logging
This option can be specified without value to enable it.
Default: true
log.file string Shortcut for ‘--log.output file://'
Default: `""`
log.file-group string Group to use for new log file, user must be a member of this group
Default: ""
Introduced in: v3.4.5, v3.5.0
log.file-mode string Mode to use for new log file, umask will be applied as well
Default: ""
Introduced in: v3.4.5, v3.5.0
log.force-direct boolean Do not start a seperate thread for logging
This option can be specified without value to enable it.
Default: false
log.foreground-tty boolean Also log to tty if backgrounded
This option can be specified without value to enable it.
Default: false
log.ids boolean Log unique message ids
This option can be specified without value to enable it.
Default: true
Introduced in: v3.5.0
log.keep-logrotate boolean Keep the old log file after receiving a sighup
This option can be specified without value to enable it.
Default: false
log.level string… The global or topic-specific log level
Default: ["info","info"]
log.line-number boolean Append line number and file name
This option can be specified without value to enable it.
Default: false
log.output string… Log destination(s)
Default: []
log.performance boolean Shortcut for ‘--log.level performance=trace’
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0
log.prefix string Prefix log message with this string
Default: ""
log.request-parameters boolean Include full urls and http request parameters in trace logs
This option can be specified without value to enable it.
Default: true
log.role boolean Log server role
This option can be specified without value to enable it.
Default: false
log.shorten-filenames boolean Shorten filenames in log output (use with --log.line-number)
This option can be specified without value to enable it.
Default: true
log.thread boolean Show thread identifier in log message
This option can be specified without value to enable it.
Default: false
log.thread-name boolean Show thread name in log message
This option can be specified without value to enable it.
Default: false
log.time-format string Time format to use in logs
Default: "utc-datestring"
Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis”
Introduced in: v3.5.0
log.use-local-time boolean Use local timezone instead of utc
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0
log.use-microtime boolean Use microtime instead
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0

Nonce

Also see Nonce details.

Name Type Description
nonce.size uint64 The size of the hash array for nonces
Default: 4194304

Query

Also see Query details.

Name Type Description
query.cache-entries uint64 Maximum number of results in query result cache per database
Default: 128
query.cache-entries-max-size uint64 Maximum cumulated size of results in query result cache per database
Default: 268435456
query.cache-entry-max-size uint64 Maximum size of an invidiual result entry in query result cache
Default: 16777216
query.cache-include-system-collections boolean Whether or not to include system collection queries in the query result cache
This option can be specified without value to enable it.
Default: false
query.cache-mode string Mode for the aql query result cache (on, off, demand)
Default: "off"
query.fail-on-warning boolean Whether aql queries should fail with errors even for recoverable warnings
This option can be specified without value to enable it.
Default: false
query.memory-limit uint64 Memory threshold for aql queries (in bytes)
Default: 0
query.optimizer-max-plans uint64 Maximum number of query plans to create for a query
Default: 128
query.registry-ttl double Default time-to-live of cursors and query snippets (in seconds); if <= 0, value will default to 30 for single-server instances or 600 for cluster instances
Default: 0
query.slow-streaming-threshold double Threshold for slow streaming aql queries (in seconds)
Default: 10
query.slow-threshold double Threshold for slow aql queries (in seconds)
Default: 10
query.smart-joins boolean Enterprise Edition only
Enable smart joins query optimization
This option can be specified without value to enable it.
Default: true
Introduced in: v3.4.5, v3.5.0
query.tracking boolean Whether to track slow aql queries
This option can be specified without value to enable it.
Default: true
query.tracking-with-bindvars boolean Whether to track bind vars with aql queries
This option can be specified without value to enable it.
Default: true

Random

Also see Random details.

Name Type Description
random.generator uint32 Random number generator to use (1 = mersenne, 2 = random, 3 = urandom, 4 = combined (not for windows), 5 = wincrypt (windows only)
Default: 1
Possible values: 1, 2, 3, 4

Replication

Also see Replication details.

Name Type Description
replication.active-failover boolean Enable active-failover during asynchronous replication
This option can be specified without value to enable it.
Default: false
replication.auto-start boolean Switch to enable or disable the automatic start of replication appliers
This option can be specified without value to enable it.
Default: true
replication.automatic-failover boolean Please use --replication.active-failover instead
This option can be specified without value to enable it.
Default: false
replication.max-parallel-tailing-invocations uint64 Maximum number of concurrently allowed wal tailing invocations (0 = unlimited)
Default: 0
Introduced in: v3.5.0

Rocksdb

Also see Rocksdb details.

Name Type Description
rocksdb.allow-fallocate boolean If true, allow rocksdb to use fallocate calls. if false, fallocate calls are bypassed
This option can be specified without value to enable it.
Default: true
Introduced in: v3.4.5, v3.5.0
rocksdb.block-align-data-blocks boolean If true, aligns data blocks on lesser of page size and block size
This option can be specified without value to enable it.
Default: false
rocksdb.block-cache-shard-bits int64 Number of shard bits to use for block cache (use -1 for default value)
Default: -1
rocksdb.block-cache-size uint64 Size of block cache in bytes
Default: dynamic (e.g. 39903603916)
rocksdb.compaction-read-ahead-size uint64 If non-zero, we perform bigger reads when doing compaction. if you’re running rocksdb on spinning disks, you should set this to at least 2mb. that way rocksdb’s compaction is doing sequential instead of random reads.
Default: 2097152
rocksdb.debug-logging boolean True to enable rocksdb debug logging
This option can be specified without value to enable it.
Default: false
rocksdb.delayed-write-rate uint64 Limited write rate to db (in bytes per second) if we are writing to the last mem-table allowed and we allow more than 3 mem-tables, or if we have surpassed a certain number of level-0 files and need to slowdown writes
Default: 0
rocksdb.dynamic-level-bytes boolean If true, determine the number of bytes for each level dynamically to minimize space amplification
This option can be specified without value to enable it.
Default: true
rocksdb.enable-pipelined-write boolean If true, use a two stage write queue for wal writes and memtable writes
This option can be specified without value to enable it.
Default: false
rocksdb.enable-statistics boolean Whether or not rocksdb statistics should be turned on
This option can be specified without value to enable it.
Default: false
rocksdb.encryption-key-generator string Enterprise Edition only
Program providing the encryption key on stdout. if set, encryption will be enabled.
Default: ""
rocksdb.encryption-keyfile string Enterprise Edition only
File containing encryption key. if set, encryption will be enabled.
Default: ""
rocksdb.enforce-block-cache-size-limit boolean If true, strictly enforces the block cache size limit
This option can be specified without value to enable it.
Default: false
rocksdb.intermediate-commit-count uint64 An intermediate commit will be performed automatically when this number of operations is reached in a transaction
Default: 1000000
rocksdb.intermediate-commit-size uint64 An intermediate commit will be performed automatically when a transaction has accumulated operations of this size (in bytes)
Default: 536870912
rocksdb.level0-compaction-trigger int64 Number of level-0 files that triggers a compaction
Default: 2
rocksdb.level0-slowdown-trigger int64 Number of level-0 files that triggers a write slowdown
Default: 20
rocksdb.level0-stop-trigger int64 Number of level-0 files that triggers a full write stall
Default: 36
rocksdb.limit-open-files-at-startup boolean Limit 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, v3.5.0
rocksdb.max-background-jobs int32 Maximum number of concurrent background jobs (compactions and flushes)
Default: dynamic (e.g. 8)
rocksdb.max-bytes-for-level-base uint64 If not using dynamic level sizes, this controls the maximum total data size for level-1
Default: 268435456
rocksdb.max-bytes-for-level-multiplier double If not using dynamic level sizes, the maximum number of bytes for level l can be calculated as max-bytes-for-level-base * (max-bytes-for-level-multiplier ^ (l-1))
Default: 10
rocksdb.max-subcompactions uint64 Maximum number of concurrent subjobs for a background compaction
Default: 1
rocksdb.max-total-wal-size uint64 Maximum total size of wal files that will force flush stale column families
Default: 83886080
rocksdb.max-transaction-size uint64 Transaction size limit (in bytes)
Default: 18446744073709551615
rocksdb.max-write-buffer-number uint64 Maximum number of write buffers that built up in memory
Default: 9
rocksdb.min-write-buffer-number-to-merge uint64 Minimum number of write buffers that will be merged together before writing to storage
Default: 1
rocksdb.num-levels uint64 Number of levels for the database
Default: 7
rocksdb.num-threads-priority-high uint32 Number of threads for high priority operations (e.g. flush)
Default: 0
rocksdb.num-threads-priority-low uint32 Number of threads for low priority operations (e.g. compaction)
Default: 0
rocksdb.num-uncompressed-levels uint64 Number of uncompressed levels for the database
Default: 2
rocksdb.optimize-filters-for-hits boolean This flag specifies that the implementation should optimize the filters mainly for cases where keys are found rather than also optimize for keys missed. this would be used in cases where the application knows that there are very few misses or the performance in the case of misses is not important
This option can be specified without value to enable it.
Default: false
rocksdb.recycle-log-file-num boolean If true, keep a pool of log files around for recycling
This option can be specified without value to enable it.
Default: false
rocksdb.sync-interval uint64 Interval for automatic, non-requested disk syncs (in milliseconds, use 0 to turn automatic syncing off)
Default: 100
rocksdb.table-block-size uint64 Approximate size (in bytes) of user data packed per block
Default: 16384
rocksdb.throttle boolean Enable write-throttling
This option can be specified without value to enable it.
Default: true
rocksdb.total-write-buffer-size uint64 Maximum total size of in-memory write buffers (0 = unbounded)
Default: dynamic (e.g. 53204805222)
rocksdb.transaction-lock-timeout int64 If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a document. a negative value is not recommended as it can lead to deadlocks (0 = no waiting, < 0 no timeout)
Default: 1000
rocksdb.use-direct-io-for-flush-and-compaction boolean Use o_direct for flush and compaction
This option can be specified without value to enable it.
Default: false
rocksdb.use-direct-reads boolean Use o_direct for reading files
This option can be specified without value to enable it.
Default: false
rocksdb.use-file-logging boolean Use a file-base logger for rocksdb’s own logs
This option can be specified without value to enable it.
Default: false
rocksdb.use-fsync boolean Issue an fsync when writing to disk (set to true for issuing fdatasync only)
This option can be specified without value to enable it.
Default: false
rocksdb.wal-archive-size-limit uint64 Maximum total size (in bytes) of archived wal files (0 = unlimited)
Default: 0
rocksdb.wal-directory string Optional path to the rocksdb wal directory. if not set, the wal directory will be located inside the regular data directory
Default: ""
rocksdb.wal-file-timeout double Timeout after which unused wal files are deleted
Default: 10
rocksdb.wal-file-timeout-initial double Initial timeout after which unused wal files deletion kicks in after server start
Default: 180
rocksdb.wal-recovery-skip-corrupted boolean Skip corrupted records in wal recovery
This option can be specified without value to enable it.
Default: false
rocksdb.write-buffer-size uint64 Amount of data to build up in memory before converting to a sorted on-disk file (0 = disabled)
Default: 67108864

Server

Also see Server details.

Name Type Description
server.allow-use-database boolean Allow change of database in rest actions, only needed for unittests
This option can be specified without value to enable it.
Default: false
server.authentication boolean Enable authentication for all client requests
This option can be specified without value to enable it.
Default: true
server.authentication-system-only boolean Use http authentication only for requests to /_api and /_admin
This option can be specified without value to enable it.
Default: true
server.authentication-timeout double Timeout for the authentication cache in seconds (0 = indefinitely)
Default: 0
server.authentication-unix-sockets boolean Authentication for requests via unix domain sockets
This option can be specified without value to enable it.
Default: true
server.check-max-memory-mappings boolean Check the maximum number of memory mappings at runtime
This option can be specified without value to enable it.
Default: true
server.descriptors-minimum uint64 Minimum number of file descriptors needed to start
Default: 0
server.endpoint string… Endpoint for client requests (e.g. ‘http+tcp://127.0.0.1:8529’, or ‘vst+ssl://192.168.1.1:8529’)
Default: ["tcp://0.0.0.0:8529"]
server.flush-interval uint64 Interval (in microseconds) for flushing data
Default: 1000000
server.gid string Switch to group-id after reading config files
Default: ""
server.harden boolean Lock down rest apis that reveal version information or server internals for non-admin users
This option can be specified without value to enable it.
Default: false
Introduced in: v3.5.0
server.io-threads uint64 Number of threads used to handle io
Default: dynamic (e.g. 8)
server.jwt-secret string Secret to use when doing jwt authentication
Default: ""
Deprecated in: v3.3.22, v3.4.2
server.jwt-secret-keyfile string File containing jwt secret to use when doing jwt authentication.
Default: ""
server.local-authentication boolean Enable authentication using the local user database
This option can be specified without value to enable it.
Default: true
server.maintenance-actions-block int32 Minimum number of seconds finished actions block duplicates
Default: 2
server.maintenance-actions-linger int32 Minimum number of seconds finished actions remain in deque
Default: 3600
server.maintenance-threads uint32 Maximum number of threads available for maintenance actions
Default: dynamic (e.g. 9)
server.maximal-queue-size uint64 Size of the priority 2 fifo
Default: 4096
server.maximal-threads uint64 Maximum number of request handling threads to run (0 = use system-specific default of 64)
Default: dynamic (e.g. 0)
server.minimal-threads uint64 Minimum number of request handling threads to run
Default: 2
server.prio1-size uint64 Size of the priority 1 fifo
Default: 1048576
server.rest-server boolean Start a rest-server
This option can be specified without value to enable it.
Default: true
server.scheduler-queue-size uint64 Number of simultaneously queued requests inside the scheduler
Default: 128
server.statistics boolean Turn statistics gathering on or off
This option can be specified without value to enable it.
Default: true
server.storage-engine string Storage engine type
Default: "auto"
Possible values: “auto”, “mmfiles”, “rocksdb”
server.uid string Switch to user-id after reading config files
Default: ""

Ssl

Also see Ssl details.

Name Type Description
ssl.cafile string Ca file used for secure connections
Default: ""
ssl.cipher-list string Ssl ciphers to use, see openssl documentation
Default: "HIGH:!EXPORT:!aNULL@STRENGTH"
ssl.ecdh-curve string Ssl ecdh curve, see the output of “openssl ecparam -list_curves”
Default: "prime256v1"
ssl.keyfile string Key-file used for secure connections
Default: ""
ssl.options uint64 Ssl connection options, see openssl documentation
Default: 2147485780
ssl.protocol uint64 Ssl protocol (1 = sslv2 (unsupported), 2 = sslv2 or sslv3 (negotiated), 3 = sslv3, 4 = tlsv1, 5 = tlsv1.2)
Default: 5
Possible values: 1, 2, 3, 4, 5
ssl.require-peer-certificate boolean Enterprise Edition only
Require a peer certificate when connecting
This option can be specified without value to enable it.
Default: false
ssl.session-cache boolean Enable the session cache for connections
This option can be specified without value to enable it.
Default: false

Tcp

Also see Tcp details.

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

Temp

Also see Temp details.

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

Ttl

Also see Ttl details.

Name Type Description
ttl.frequency uint64 Frequency (in milliseconds) for the ttl background thread invocation. a value of 0 turns the ttl background thread off entirely
Default: 30000
ttl.max-collection-removes uint64 Maximum number of documents to remove per collection
Default: 1000000
ttl.max-total-removes uint64 Maximum number of documents to remove per invocation of the ttl thread
Default: 1000000
ttl.only-loaded-collection boolean Only consider already loaded collections for removal
This option can be specified without value to enable it.
Default: true

Vst

Also see Vst details.

Name Type Description
vst.maxsize uint32 Maximal size (in bytes) for a velocypack chunk
Default: 30720

Wal

Also see Wal details.

Name Type Description
wal.allow-oversize-entries boolean Allow entries that are bigger than ‘--wal.logfile-size’
This option can be specified without value to enable it.
Default: true
wal.directory string Logfile directory
Default: ""
wal.flush-timeout uint64 Flush timeout (in milliseconds)
Default: 15000
wal.historic-logfiles uint32 Maximum number of historic logfiles to keep after collection
Default: 10
wal.ignore-logfile-errors boolean Ignore logfile errors. this will read recoverable data from corrupted logfiles but ignore any unrecoverable data
This option can be specified without value to enable it.
Default: false
wal.ignore-recovery-errors boolean Continue recovery even if re-applying operations fails
This option can be specified without value to enable it.
Default: false
wal.logfile-size uint32 Size of each logfile (in bytes)
Default: 33554432
wal.open-logfiles uint32 Maximum number of parallel open logfiles
Default: 0
wal.reserve-logfiles uint32 Maximum number of reserve logfiles to maintain
Default: 3
wal.slots uint32 Number of logfile slots to use
Default: 1048576
wal.sync-interval uint64 Interval for automatic, non-requested disk syncs (in milliseconds)
Default: 100
wal.throttle-wait uint64 Maximum wait time per operation when write-throttled (in milliseconds)
Default: 15000
wal.throttle-when-pending uint64 Throttle writes when at least this many operations are waiting for collection (set to 0 to deactivate write-throttling)
Default: 0
wal.use-mlock boolean Mlock wal logfiles in memory (may require elevated privileges or limits)
This option can be specified without value to enable it.
Default: false