Using the Command Line
Description — Start a Sync Gateway instance using command line options and securely sync enterprise data from cloud to edge
Abstract — Introduces the options available when running Sync Gateway from the command line
Related Content — Deploy | REST API Access | Configuration File
Overview
You can configure some Sync Gateway features by specifying command-line options when you start it.
For more comprehensive configuration, use a JSON configuration file - see: Configuration File.
Configuration
Configuration determines the runtime behavior of Sync Gateway, including server configuration and the database or set of databases with which a Sync Gateway instance can interact.
Command-line options can only specify a sub-set of the available configuration properties, and cannot be used to configure multiple databases. |
Two command-line options do not have corresponding configuration properties: -help
and -verbose
.
Option Format
When specifying command-line options use the format shown in Example 1
-
Command-line options are case-insensitive.
-
You can prefix command-line options with one hyphen (-) or with two hyphens (--).
-
For command-line options that take an argument, you specify the argument after an equal sign (=).
For example,-bucket=db
, or as a following item on the command line, for example,-bucket db
.
sync_gateway [command-line options]
Available Options
The following command-line options can be used when starting Sync Gateway see Table 1
Deprecation Notice
The -bucket command line option is deprecated at Release 2.7 and will be removed following release 2.8.Use the JSON configuration file option bucket — see this_db_bucket.
|
Option | Default | Description |
---|---|---|
|
|
Port or TCP network address (IP address and the port) that the Admin REST API listens on. |
|
|
Deprecated Name of the Couchbase Server bucket. |
|
|
Name of the Couchbase Server database to serve through the Public REST API. |
|
none |
Path to log files, as a fallback default value when |
|
none |
Lists the available options and exits. |
|
|
Port or TCP network address (IP address and the port) that the Public REST API listens on. |
|
|
Comma-separated list of log keywords to enable.
The log keyword |
|
none |
Path to log files. |
|
|
Name of the Couchbase Server pool in which to find buckets. |
|
|
Pretty-print JSON responses to improve readability. This is useful for debugging, but reduces performance. |
|
|
URL of the database server.
(Deprecated) An HTTP URL implies Couchbase Server.
A |
|
Non-verbose logging |
Logs more information about requests. |
Examples
The following command does not include any parameters and just uses the default values.
It connects to the bucket named sync_gateway
in the pool named default
of the built-in Walrus database.
It is served from port 4984, with the Admin interface on port 4985.
$ sync_gateway
The following command creates an ephemeral, in-memory Walrus database, served as db
, and specifies use of pretty-printed JSON responses.
Because Walrus is the default database, the option -url
could be omitted.
$ sync_gateway -url=walrus: -bucket=db -pretty
The following command starts Sync Gateway and specifies the address of a Couchbase Server instance (instead of using the default database server, which is Walrus):
$ ./sync_gateway -url http://cbserver:8091
The following command accomplishes the same things as the prior command, persists the Walrus database to a file named /tmp/walrus/db.walrus
, and turns on additional logging for the log keys HTTP+
and CRUD
.
$ sync_gateway -url=walrus:///tmp/walrus -bucket=db -log=HTTP+,CRUD