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.

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

Global Options

Also see Global details.

NameTypeDescription
configurationstring The configuration file or 'none'.
Default: ""
consoleboolean Start a JavaScript emergency console.
Default: false
versionboolean Reports the version and exits.
Default: false

Agency Options

Also see Agency details.

NameTypeDescription
agency.activateboolean Activate agency.
Default: false
agency.compaction-keep-sizeuint64 Keep as many indices before compaction point.
Default: 50000
agency.election-timeout-maxdouble Maximum timeout before an agent calls for new election [s].
Default: 5
agency.election-timeout-mindouble Minimum timeout before an agent calls for new election [s].
Default: 1
agency.endpointstring... Agency endpoints.
Default: []
agency.my-addressstring Which address to advertise to the outside.
Default: ""
agency.pool-sizeuint64 Number of agent pool.
Default: 1
agency.sizeuint64 Number of agents.
Default: 1
agency.supervisionboolean Perform arangodb cluster supervision.
Default: false
agency.supervision-frequencydouble Arangodb cluster supervision frequency [s].
Default: 1
agency.supervision-grace-perioddouble Supervision time, after which a server is considered to have failed [s].
Default: 10

Arangosearch Options

Also see Arangosearch details.

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

Audit Options

Also see Audit details.

NameTypeDescription
audit.hostnamestring Hostname to use.
Default: ""
audit.outputstring... Audit destination(s).
Default: []

Cache Options

Also see Cache details.

NameTypeDescription
cache.rebalancing-intervaluint64 Microseconds between rebalancing attempts.
Default: 2000000
cache.sizeuint64 Size of cache in bytes.
Default: 16329139200

Cluster Options

Also see Cluster details.

NameTypeDescription
cluster.agency-endpointstring... Agency endpoint to connect to.
Default: []
cluster.my-addressstring This server's endpoint (cluster internal).
Default: ""
cluster.my-advertised-endpointstring This server's advertised endpoint (e.g. external IP address or load balancer, optional).
Default: ""
cluster.my-rolestring This server's role.
Default: ""
cluster.require-persisted-idboolean 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.
Default: false
cluster.synchronous-replication-timeout-factordouble All synchronous replication timeouts are multiplied by this factor.
Default: 1
cluster.system-replication-factoruint32 Replication factor for system collections.
Default: 2

Compaction Options

Also see Compaction details.

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

Database Options

Also see Database details.

NameTypeDescription
database.auto-upgradeboolean Perform a database upgrade if necessary.
Default: false
database.directorystring Path to the database directory.
Default: ""
database.maximal-journal-sizeuint64 Default maximal journal size, can be overwritten when creating a collection.
Default: 33554432
database.required-directory-statestring 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"

Foxx Options

Also see Foxx details.

NameTypeDescription
foxx.queuesboolean Enable Foxx queues.
Default: true
foxx.queues-poll-intervaldouble Poll interval (in seconds) for Foxx queue manager.
Default: 1

Frontend Options

Also see Frontend details.

NameTypeDescription
frontend.proxy-request-checkboolean Enable proxy request checking.
Default: true
frontend.trusted-proxystring... List of proxies to trust (may be IP or network). Make sure --frontend.proxy-request-check is enabled.
Default: []

Http Options

Also see Http details.

NameTypeDescription
http.hide-product-headerboolean Do not expose "Server: ArangoDB" header in HTTP responses.
Default: false
http.keep-alive-timeoutdouble Keep-alive timeout in seconds.
Default: 300
http.trusted-originstring... Trusted origin URLs for CORS requests with credentials.
Default: []

Javascript Options

Also see Javascript details.

NameTypeDescription
javascript.app-pathstring Directory for Foxx applications.
Default: "./js/apps"
javascript.copy-installationboolean Copy contents of 'javascript.startup-directory' on first start.
Default: false
javascript.scriptstring... Run scripts and exit.
Default: []
javascript.script-parameterstring... Script parameter.
Default: []
javascript.startup-directorystring Path to the directory containing JavaScript startup scripts.
Default: "./js"
javascript.v8-contextsuint64 Maximum number of V8 contexts that are created for executing JavaScript actions.
Default: 0
javascript.v8-contexts-minimumuint64 Minimum number of V8 contexts that keep available for executing JavaScript actions.
Default: 0
javascript.v8-max-heapuint64 Maximal heap size (in MB).
Default: 3072

Ldap Options

Also see Ldap details.

NameTypeDescription
ldap.basednstring Ldap basedn, eg. dc=example,dc=com.
Default: ""
ldap.binddnstring Ldap binddn, eg. cn=admin,dc=example,dc=com.
Default: ""
ldap.bindpasswdstring Ldap bindpassword, eg. admin.
Default: ""
ldap.enabledboolean Enable LDAP.
Default: false
ldap.network-timeoutdouble 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 Port to use.
Default: 389
ldap.prefixstring Ldap prefix, eg. uid= xor dn= xor cn=.
Default: ""
ldap.refresh-ratedouble Refresh user settings after this time (in seconds).
Default: 300
ldap.restartboolean Whether or not the LDAP library should implicitly restart connections.
Default: false
ldap.retriesuint32 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-namestring Ldap attributename where the role are located.
Default: ""
ldap.roles-excludestring Regexp to exclude groups. Leave empty to exclude none.
Default: ""
ldap.roles-includestring Regexp to include groups. Leave empty to include all.
Default: ""
ldap.roles-searchstring Ldap search for roles; '{USER}' is replaced by the 'dn' of the user.
Default: ""
ldap.roles-transformationstring... Regexp to normalizer role name, e.g. '/^ *(.*[^ ]])*/$2/'.
Default: []
ldap.search-attributestring Ldap search attribute, eg. uid.
Default: "uid"
ldap.search-filterstring Ldap search filter, eg. (objectClass=simpleSecurityObject).
Default: "objectClass=*"
ldap.search-scopestring Ldap search scope, one of base, one, sub.
Default: "sub"
ldap.serverstring Server to use.
Default: ""
ldap.suffixstring Ldap suffix, eg. ,dc=example,dc=com.
Default: ""
ldap.superuser-rolestring Role mapping to the super-users.
Default: ""
ldap.timeoutdouble Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout).
Default: 0
ldap.tlsboolean Enable TLS.
Default: false
ldap.tls-cacert-dirstring Ldap tls cacert dir.
Default: ""
ldap.tls-cacert-filestring Ldap tls cacert file.
Default: ""
ldap.tls-cert-check-strategystring Ldap tls cert check strategy, one of never, hard, demand, allow, try.
Default: "hard"
ldap.tls-versionstring Ldap tls version, one of 1.0, 1.1, 1.2.
Default: "1.2"
ldap.urlstring Ldap url, eg. ldap://example.com:389/dc=example,dc=com?uid?sub.
Default: ""

Log Options

Also see Log details.

NameTypeDescription
log.colorboolean Use colors for TTY logging.
Default: true
log.escapeboolean Escape characters when logging.
Default: true
log.levelstring... The global or topic-specific log level.
Default: ["info", "info"]
log.outputstring... Log destination(s).
Default: []
log.roleboolean Log server role.
Default: false
log.use-local-timeboolean Use local timezone instead of UTC.
Default: false
log.use-microtimeboolean Use microtime instead.
Default: false

Nonce Options

Also see Nonce details.

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

Query Options

Also see Query details.

NameTypeDescription
query.cache-entriesuint64 Maximum number of results in query result cache per database.
Default: 128
query.cache-entries-max-sizeuint64 Maximum cumulated size of results in query result cache per database.
Default: 268435456
query.cache-entry-max-sizeuint64 Maximum size of an invidiual result entry in query result cache.
Default: 16777216
query.cache-include-system-collectionsboolean Whether or not to include system collection queries in the query result cache.
Default: false
query.cache-modestring Mode for the AQL query result cache (on, off, demand).
Default: "off"
query.fail-on-warningboolean Whether AQL queries should fail with errors even for recoverable warnings.
Default: false
query.memory-limituint64 Memory threshold for AQL queries (in bytes).
Default: 0
query.optimizer-max-plansuint64 Maximum number of query plans to create for a query.
Default: 128
query.slow-streaming-thresholddouble Threshold for slow streaming AQL queries (in seconds).
Default: 10
query.slow-thresholddouble Threshold for slow AQL queries (in seconds).
Default: 10
query.trackingboolean Whether to track slow AQL queries.
Default: true
query.tracking-with-bindvarsboolean Whether to track bind vars with AQL queries.
Default: true

Replication Options

Also see Replication details.

NameTypeDescription
replication.active-failoverboolean Enable active-failover during asynchronous replication.
Default: false

Rocksdb Options

Also see Rocksdb details.

NameTypeDescription
rocksdb.block-align-data-blocksboolean If true, aligns data blocks on lesser of page size and block size.
Default: false
rocksdb.block-cache-shard-bitsint64 Number of shard bits to use for block cache (use -1 for default value).
Default: -1
rocksdb.block-cache-sizeuint64 Size of block cache in bytes.
Default: 19594967040
rocksdb.compaction-read-ahead-sizeuint64 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.dynamic-level-bytesboolean If true, determine the number of bytes for each level dynamically to minimize space amplification.
Default: true
rocksdb.enable-pipelined-writeboolean If true, use a two stage write queue for WAL writes and memtable writes.
Default: false
rocksdb.enable-statisticsboolean Whether or not RocksDB statistics should be turned on.
Default: false
rocksdb.encryption-key-generatorstringEnterprise Edition only
Program providing the encryption key on stdout. If set, encryption will be enabled.
Default: ""
rocksdb.encryption-keyfilestringEnterprise Edition only
File containing encryption key. If set, encryption will be enabled.
Default: ""
rocksdb.enforce-block-cache-size-limitboolean If true, strictly enforces the block cache size limit.
Default: false
rocksdb.intermediate-commit-countuint64 An intermediate commit will be performed automatically when this number of operations is reached in a transaction.
Default: 1000000
rocksdb.intermediate-commit-sizeuint64 An intermediate commit will be performed automatically when a transaction has accumulated operations of this size (in bytes).
Default: 536870912
rocksdb.level0-compaction-triggerint64 Number of level-0 files that triggers a compaction.
Default: 2
rocksdb.level0-slowdown-triggerint64 Number of level-0 files that triggers a write slowdown.
Default: 20
rocksdb.level0-stop-triggerint64 Number of level-0 files that triggers a full write stall.
Default: 36
rocksdb.max-bytes-for-level-baseuint64 If not using dynamic level sizes, this controls the maximum total data size for level-1.
Default: 268435456
rocksdb.max-bytes-for-level-multiplierdouble 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-subcompactionsuint64 Maximum number of concurrent subjobs for a background compaction.
Default: 1
rocksdb.max-total-wal-sizeuint64 Maximum total size of WAL files that will force flush stale column families.
Default: 83886080
rocksdb.max-transaction-sizeuint64 Transaction size limit (in bytes).
Default: 18446744073709551615
rocksdb.max-write-buffer-numberuint64 Maximum number of write buffers that built up in memory.
Default: 2
rocksdb.min-write-buffer-number-to-mergeuint64 Minimum number of write buffers that will be merged together before writing to storage.
Default: 1
rocksdb.num-levelsuint64 Number of levels for the database.
Default: 7
rocksdb.num-threads-priority-highuint32 Number of threads for high priority operations (e.g. flush).
Default: 0
rocksdb.num-threads-priority-lowuint32 Number of threads for low priority operations (e.g. compaction).
Default: 0
rocksdb.num-uncompressed-levelsuint64 Number of uncompressed levels for the database.
Default: 2
rocksdb.sync-intervaluint64 Interval for automatic, non-requested disk syncs (in milliseconds, use 0 to turn automatic syncing off).
Default: 100
rocksdb.table-block-sizeuint64 Approximate size (in bytes) of user data packed per block.
Default: 16384
rocksdb.throttleboolean Enable write-throttling.
Default: true
rocksdb.total-write-buffer-sizeuint64 Maximum total size of in-memory write buffers (0 = unbounded).
Default: 32658278400
rocksdb.transaction-lock-timeoutint64 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.wal-directorystring 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-timeoutdouble Timeout after which unused WAL files are deleted.
Default: 10
rocksdb.write-buffer-sizeuint64 Amount of data to build up in memory before converting to a sorted on-disk file (0 = disabled).
Default: 67108864

Server Options

Also see Server details.

NameTypeDescription
server.authenticationboolean Enable authentication for ALL client requests.
Default: true
server.authentication-system-onlyboolean Use HTTP authentication only for requests to /_api and /_admin.
Default: true
server.authentication-timeoutdouble Timeout for the authentication cache in seconds (0 = indefinitely).
Default: 0
server.authentication-unix-socketsboolean Authentication for requests via UNIX domain sockets.
Default: true
server.descriptors-minimumuint64 Minimum 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.jwt-secretstring Secret to use when doing jwt authentication.
Default: ""
server.local-authenticationboolean Enable authentication using the local user database.
Default: true
server.maximal-queue-sizeuint64 Size of the priority 2 fifo.
Default: 4096
server.maximal-threadsuint64 Maximum number of request handling threads to run (0 = use system-specific default of 64).
Default: 0
server.storage-enginestring Storage engine type.
Default: "auto"
Possible values:
  • "auto"
  • "mmfiles"
  • "rocksdb"

Ssl Options

Also see Ssl details.

NameTypeDescription
ssl.cafilestring Ca file used for secure connections.
Default: ""
ssl.cipher-liststring Ssl ciphers to use, see OpenSSL documentation.
Default: "HIGH:!EXPORT:!aNULL@STRENGTH"
ssl.ecdh-curvestring SSL ECDH Curve, see the output of "openssl ecparam -list_curves".
Default: "prime256v1"
ssl.keyfilestring Key-file used for secure connections.
Default: ""
ssl.protocoluint64 Ssl protocol (1 = SSLv2, 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2).
Default: 5
Possible values:
  • 1
  • 2
  • 3
  • 4
  • 5
ssl.require-peer-certificateboolean Require a peer certificate when connecting.
Default: false
ssl.session-cacheboolean Enable the session cache for connections.
Default: false

Temp Options

Also see Temp details.

NameTypeDescription
temp.pathstring Path for temporary files.
Default: ""

Vst Options

Also see Vst details.

NameTypeDescription
vst.maxsizeuint32 Maximal size (in bytes) for a VelocyPack chunk.
Default: 30720

Wal Options

Also see Wal details.

NameTypeDescription
wal.directorystring Logfile directory.
Default: ""
wal.historic-logfilesuint32 Maximum number of historic logfiles to keep after collection.
Default: 10
wal.ignore-logfile-errorsboolean Ignore logfile errors. this will read recoverable data from corrupted logfiles but ignore any unrecoverable data.
Default: false
wal.ignore-recovery-errorsboolean Continue recovery even if re-applying operations fails.
Default: false
wal.logfile-sizeuint32 Size of each logfile (in bytes).
Default: 33554432
wal.open-logfilesuint32 Maximum number of parallel open logfiles.
Default: 0
wal.reserve-logfilesuint32 Maximum number of reserve logfiles to maintain.
Default: 3
wal.sync-intervaluint64 Interval for automatic, non-requested disk syncs (in milliseconds).
Default: 100