OS Manuals

/usr/bin/rethinkdb

The open-source database for the realtime web.

From rethinkdb 2.4.4-r16 (os), captured 2026-11-05 by running rethinkdb --help (exit 0). permalink

Running 'rethinkdb' will create a new data directory or use an existing one,
  and serve as a RethinkDB server.
File path options:
  -d [ --directory ] path   specify directory to store data and metadata
  --io-threads n            how many simultaneous I/O operations can happen at
                            the same time
  --direct-io               use direct I/O for file access
  --cache-size mb           total cache size (in megabytes) for the process.
                            Can be 'auto'.

Server options:
  -n [ --server-name ] arg  the name for this server (as will appear in the
                            metadata).  If not specified, one will be generated
                            from the hostname and a random alphanumeric string.
  -t [ --server-tag ] arg   a tag for this server. Can be specified multiple
                            times.

Network options:
  --bind {all | addr}       add the address of a local interface to listen on
                            when accepting connections, loopback addresses are
                            enabled by default. Can be overridden by the
                            following three options.
  --bind-cluster {all | addr}
                            override the behavior specified by --bind for
                            cluster connections.
  --bind-driver {all | addr}
                            override the behavior specified by --bind for
                            client driver connections.
  --bind-http {all | addr}  override the behavior specified by --bind for web
                            console connections.
  --no-default-bind         disable automatic listening on loopback addresses
  --cluster-port port       port for receiving connections from other servers
  --driver-port port        port for rethinkdb protocol client drivers
  -o [ --port-offset ] offset
                            all ports used locally will have this value added
  -j [ --join ] host[:port]
                            host and port of a rethinkdb server to connect to
  --reql-http-proxy [protocol://]host[:port]
                            HTTP proxy to use for performing `r.http(...)`
                            queries, default port is 1080
  --canonical-address host[:port]
                            address that other rethinkdb instances will use to
                            connect to us, can be specified multiple times
  --join-delay seconds      hold the TCP connection open for these many seconds
                            before joining with another server
  --cluster-reconnect-timeout seconds
                            maximum number of seconds to attempt reconnecting
                            to a server before giving up, the default is 24
                            hours

TLS options:
  --http-tls-key key_filename
                            private key to use for web administration console
                            TLS
  --http-tls-cert cert_filename
                            certificate to use for web administration console
                            TLS
  --driver-tls-key key_filename
                            private key to use for client driver connection TLS
  --driver-tls-cert cert_filename
                            certificate to use for client driver connection TLS
  --driver-tls-ca ca_filename
                            CA certificate bundle used to verify client
                            certificates; TLS client authentication disabled if
                            omitted
  --cluster-tls-key key_filename
                            private key to use for intra-cluster connection TLS
  --cluster-tls-cert cert_filename
                            certificate to use for intra-cluster connection TLS
  --cluster-tls-ca ca_filename
                            CA certificate bundle used to verify cluster peer
                            certificates
  --tls-min-protocol protocol
                            the minimum TLS protocol version that the server
                            accepts; options are 'TLSv1', 'TLSv1.1', 'TLSv1.2';
                            default is 'TLSv1.2'
  --tls-ciphers cipher_list
                            specify a list of TLS ciphers to use; default is
                            'EECDH+AESGCM'
  --tls-ecdh-curve curve_name
                            specify a named elliptic curve to use for ECDHE;
                            default is 'prime256v1'
  --tls-dhparams dhparams_filename
                            provide parameters for DHE key agreement; REQUIRED
                            if using DHE cipher suites; at least 2048-bit
                            recommended

Authentication options:
  --initial-password {auto | password}
                            sets an initial password for the "admin" user on a
                            new server.  If set to auto, a random password will
                            be generated. Care should be taken when using
                            values other than auto as your password can be
                            leaked into system logs and process monitors. As a
                            safer alternative, create a file with the content
                            initial-password=Y0urP4$$woRd and load it using the
                            --config-file option.

Web options:
  --web-static-directory directory
                            the directory containing web resources for the http
                            interface
  --http-port port          port for web administration console
  --no-http-admin           disable web administration console

CPU options:
  -c [ --cores ] n          the number of cores to use

Service options:
  --pid-file path           a file in which to write the process id when the
                            process is running
  --daemon                  daemonize this rethinkdb process

Set User/Group options:
  --runuser user            run as the specified user
  --rungroup group          run with the specified group

Help options:
  -h [ --help ]             print this help
  -v [ --version ]          print the version number of rethinkdb

Log options:
  --log-file file           specify the file to log to, defaults to 'log_file'
  --no-update-check         obsolete.  Update checking has been removed.

Configuration file options:
  --config-file             take options from a configuration file


There are a number of subcommands for more specific tasks:
    'rethinkdb create': prepare files on disk for a new server instance
    'rethinkdb serve': use an existing data directory to host data and serve queries
    'rethinkdb proxy': serve queries from an existing cluster but don't host data
    'rethinkdb export': export data from an existing cluster into a file or directory
    'rethinkdb import': import data from from a file or directory into an existing cluster
    'rethinkdb dump': export and compress data from an existing cluster
    'rethinkdb restore': import compressed data into an existing cluster
    'rethinkdb index-rebuild': rebuild outdated secondary indexes
    'rethinkdb repl': start a Python REPL with the RethinkDB driver

For more information, run 'rethinkdb help [subcommand]'.
Options (40)
OptionDescriptionSource
-dspecify directory to store data and metadatahelp
--io-threads nhow many simultaneous I/O operations can happen at the same timehelp
--direct-iouse direct I/O for file accesshelp
--cache-size mbtotal cache size (in megabytes) for the process.help
-nthe name for this server (as will appear in the metadata).help
-ta tag for this server.help
--bind alladd the address of a local interface to listen on when accepting connections, loopback addresses are enabled by default.help
--bind-http alloverride the behavior specified by --bind for web console connections.help
--no-default-binddisable automatic listening on loopback addresseshelp
--cluster-port portport for receiving connections from other servershelp
--driver-port portport for rethinkdb protocol client drivershelp
--reql-http-proxy protocol://]host[:portHTTP proxy to use for performing `r.http(...)` queries, default port is 1080help
--canonical-address host[:portaddress that other rethinkdb instances will use to connect to us, can be specified multiple timeshelp
--join-delay secondshold the TCP connection open for these many seconds before joining with another serverhelp
--cluster-reconnect-timeout secondsmaximum number of seconds to attempt reconnecting to a server before giving up, the default is 24 hourshelp
--http-tls-key key_filenameprivate key to use for web administration console TLShelp
--http-tls-cert cert_filenamecertificate to use for web administration console TLShelp
--driver-tls-key key_filenameprivate key to use for client driver connection TLShelp
--driver-tls-cert cert_filenamecertificate to use for client driver connection TLShelp
--driver-tls-ca ca_filenameCA certificate bundle used to verify client certificates;help
--cluster-tls-key key_filenameprivate key to use for intra-cluster connection TLShelp
--cluster-tls-cert cert_filenamecertificate to use for intra-cluster connection TLShelp
--cluster-tls-ca ca_filenameCA certificate bundle used to verify cluster peer certificateshelp
--tls-min-protocol protocolthe minimum TLS protocol version that the server accepts;help
--tls-ciphers cipher_listspecify a list of TLS ciphers to use;help
--tls-ecdh-curve curve_namespecify a named elliptic curve to use for ECDHE;help
--tls-dhparams dhparams_filenameprovide parameters for DHE key agreement;help
--web-static-directory directorythe directory containing web resources for the http interfacehelp
--http-port portport for web administration consolehelp
--no-http-admindisable web administration consolehelp
-cthe number of cores to usehelp
--pid-file patha file in which to write the process id when the process is runninghelp
--daemondaemonize this rethinkdb processhelp
--runuser userrun as the specified userhelp
--rungroup grouprun with the specified grouphelp
-hprint this helphelp
-vprint the version number of rethinkdbhelp
--log-file filespecify the file to log to, defaults to 'log_file'help
--no-update-checkobsolete.help
--config-filetake options from a configuration filehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.