mirror of https://gitee.com/bigwinds/arangodb
53 lines
2.3 KiB
Groff
53 lines
2.3 KiB
Groff
.TH COMMAND SECTION "DATE" "" "ArangoDB"
|
|
.SH NAME
|
|
COMMAND - the ArangoDB database server
|
|
.SH SYNOPSIS
|
|
COMMAND [options] database-directory
|
|
.SH DESCRIPTION
|
|
The COMMAND binary can be used to start the ArangoDB database
|
|
server. By default, the server will run in a mode that allows
|
|
clients to connect to it via the network. The server also has
|
|
an emergency console mode that can be used for any sort of
|
|
maintenance operations. In the emergency console mode, the
|
|
server does not allow any clients to connect.
|
|
The server can be stopped gracefully at any time by pressing
|
|
CTRL-C or by sending the SIGINT signal to the process.
|
|
.SH OPTIONS
|
|
The COMMAND binary has many options that can be used to control
|
|
its behavior.
|
|
For a complete list of options, please refer to the ArangoDB
|
|
online manual, available at http://www.arangodb.org/
|
|
|
|
The most important startup options are:
|
|
|
|
OPTION "--configuration <string>"
|
|
read configuration from file <string> ENDOPTION
|
|
OPTION "--console"
|
|
do not start as server, start an emergency console instead ENDOPTION
|
|
OPTION "--log.file <string>"
|
|
log to file <string> ENDOPTION
|
|
OPTION "--log.level <string>"
|
|
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") ENDOPTION
|
|
OPTION "--server.endpoint <string>"
|
|
listen endpoint for client requests, consisting of protocol, ip address and port ENDOPTION
|
|
OPTION "--server.disable-authentication <boolean>"
|
|
disable authentication for all clients ENDOPTION
|
|
OPTION "--database.directory <string>"
|
|
path to the database directory ENDOPTION
|
|
EXAMPLES
|
|
EXAMPLE COMMAND /data/arangodb
|
|
starts the server with database directory /data/arangodb ENDEXAMPLE
|
|
EXAMPLE COMMAND --database.directory /data/arangodb
|
|
same, but uses --database.directory option instead ENDEXAMPLE
|
|
EXAMPLE COMMAND --log.level debug /data/arangodb
|
|
starts server with log level "debug" ENDEXAMPLE
|
|
EXAMPLE COMMAND --server.endpoint tcp://127.0.0.1:8529 /data/arangodb
|
|
starts server listening on port 8529 of IP 127.0.0.1 ENDEXAMPLE
|
|
EXAMPLE COMMAND --server.endpoint tcp://192.168.173.13:8529
|
|
--server.endpoint ssl://192.168.173.13:8530 /data/arangodb
|
|
starts server with two endpoints: port 8529 for unencrypted requests and 8530 for ssl-encrypted requests ENDEXAMPLE
|
|
EXAMPLE COMMAND --console /data/arangodb
|
|
starts the emergency console ENDEXAMPLE
|
|
.SH AUTHOR
|
|
Copyright triAGENS GmbH, Cologne, Germany
|