You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The following command-line options can be used when starting Sync Gateway see <<cmd-opts>>
49
77
50
78
.*Deprecation Notice*
51
-
WARNING: The `-bucket` command line option is deprecated at Release 2.7 and will be removed following release 2.8. +
79
+
WARNING: The `-bucket` command line option, deprecated at Release 2.7, will be removed following release 2.8. +
52
80
Use the JSON configuration file option `bucket` -- see {configuration-properties--xref--databases-bucket}.
53
81
54
82
[#cmd-opts]
55
83
.Available command-line options
56
-
[#cmd-opts,cols="1,1,2"]
84
+
[#cmd-opts,cols="^3m,3,4a"]
57
85
|===
58
86
|Option |Default |Description
59
87
60
-
|`‑adminInterface`
61
-
|`127.0.0.1:4985`
88
+
|‑adminInterface
89
+
|127.0.0.1:4985
62
90
|Port or TCP network address (IP address and the port) that the Admin REST API listens on.
63
91
64
-
|`-bucket`
65
-
|`sync_gateway`
66
-
|*_Deprecated_* Name of the Couchbase Server bucket.
92
+
|-bucket
93
+
|sync_gateway
94
+
|*_Deprecated_* Name of the Couchbase Server bucket. +
95
+
Instead use {configuration-properties--xref--databases-bucket}
96
+
97
+
|-cacertpath
98
+
|none
99
+
|Root CA certificate path
100
+
101
+
|-certpath
102
+
|none
103
+
|Client certificate path
67
104
68
-
|`-dbname`
69
-
|`sync_gateway`
105
+
|-configServer
106
+
|none
107
+
|URL of server that can return database configs
108
+
109
+
|-dbname
110
+
|sync_gateway
70
111
|Name of the Couchbase Server database to serve through the Public REST API.
71
112
72
-
|`-defaultLogFilePath`
113
+
|-defaultLogFilePath
73
114
|none
74
115
|Path to log files, as a fallback default value when `logFilePath` is not specified.
75
116
This option is generally used in service scripts.
76
117
77
-
|`-help`
118
+
|-deploymentID
119
+
|none
120
+
|Customer/project identifier for stats reporting
121
+
122
+
|--help
78
123
|none
79
124
|Lists the available options and exits.
80
125
81
-
|`-interface`
82
-
|`:4984`
126
+
|-interface
127
+
|:4984
83
128
|Port or TCP network address (IP address and the port) that the Public REST API listens on.
84
129
85
-
|`-log`
86
-
|`HTTP`
87
-
|Comma-separated list of log keywords to enable.
88
-
The log keyword `HTTP` is enabled by default, which means that HTTP requests and error responses are always logged.
89
-
Omitting `HTTP` from your list does not disable HTTP logging. HTTP logging can be disabled through the Admin API.
130
+
|-keypath
131
+
|none
132
+
|Client certificate key path
133
+
134
+
|-log
135
+
|HTTP
136
+
|A comma-separated list of log keywords to be enabled. +
137
+
The log keyword `HTTP` is enabled by default, which means that HTTP requests and error responses are always logged. +
138
+
Omitting `HTTP` from your list does not disable HTTP logging. You can disable HTTP logging using the Admin API.
90
139
91
-
|`-logFilePath`
140
+
|-logFilePath
92
141
|none
93
142
|Path to log files.
94
143
95
-
|`-pool`
96
-
|`default`
144
+
|-pool
145
+
|default
97
146
|Name of the Couchbase Server pool in which to find buckets.
98
147
99
-
|`-pretty`
100
-
|`false`
148
+
|-pretty
149
+
|false
101
150
|Pretty-print JSON responses to improve readability.
102
151
This is useful for debugging, but reduces performance.
103
152
104
-
|`-url`
105
-
|`walrus:`
106
-
|URL of the database server.
107
-
(*Deprecated*) An HTTP URL implies Couchbase Server.
108
-
A `walrus:` URL implies the built-in Walrus database.
109
-
A combination of a Walrus URL and a file-style URI (for example, `walrus:///tmp/walrus`) implies the built-in Walrus database and persisting the database to a file.
153
+
|-profileInterface
154
+
|
155
+
|Address to bind the profile interface to
110
156
111
-
|`-verbose`
157
+
|-url
158
+
m|DefaultServer
159
+
|The URL of the database server
160
+
161
+
|-verbose
112
162
|Non-verbose logging
113
163
|Logs more information about requests.
114
164
|===
115
165
116
-
[[_examples]]
117
-
=== Examples
118
-
119
-
The following command does not include any parameters and just uses the default values.
120
-
It connects to the bucket named `sync_gateway` in the pool named `default` of the built-in Walrus database.
121
-
It is served from port 4984, with the Admin interface on port 4985.
122
-
123
-
[source,bash]
124
-
----
125
-
$ sync_gateway
126
-
----
127
-
128
-
The following command creates an ephemeral, in-memory Walrus database, served as `db`, and specifies use of pretty-printed JSON responses.
129
-
Because Walrus is the default database, the option `-url` could be omitted.
130
-
131
-
[source,bash]
132
-
----
133
-
$ sync_gateway -url=walrus: -bucket=db -pretty
134
-
----
135
-
136
-
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):
137
-
138
-
[source,bash]
139
-
----
140
-
$ ./sync_gateway -url http://cbserver:8091
141
-
----
142
-
143
-
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`.
0 commit comments