1
1
---
2
2
title : " Configuration"
3
- date : " 2021-09-15T08:57:47 +0000"
3
+ date : " 2021-09-15T11:54:21 +0000"
4
4
weight : 20
5
5
geekdocRepo : https://github.com/owncloud/ocis
6
6
geekdocEditPath : edit/master/ocs/templates
@@ -35,191 +35,187 @@ If multiple variables are listed for one option, they are in order of precedence
35
35
36
36
If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
37
37
38
- ### ocs server
38
+ ### ocs health
39
39
40
- Start integrated server
40
+ Check health status
41
41
42
- Usage: ` ocs server [command options] [arguments...] `
42
+ Usage: ` ocs health [command options] [arguments...] `
43
43
44
44
45
+ -debug-addr | $OCS_DEBUG_ADDR
46
+ : Address to debug endpoint. Default: ` "0.0.0.0:9114" ` .
45
47
46
- -log-file | $OCS_LOG_FILE , $OCIS_LOG_FILE
47
- : Enable log to file.
48
48
49
49
50
- -log-level | $OCS_LOG_LEVEL , $OCIS_LOG_LEVEL
51
- : Set logging level.
52
50
53
51
54
- -log-pretty | $OCS_LOG_PRETTY , $OCIS_LOG_PRETTY
55
- : Enable pretty logging.
56
52
57
53
58
- -log-color | $OCS_LOG_COLOR , $OCIS_LOG_COLOR
59
- : Enable colored logging.
60
54
61
55
62
- -config-file | $OCS_CONFIG_FILE
63
- : Path to config file.
64
56
65
57
66
- -tracing-enabled | $OCS_TRACING_ENABLED , $OCIS_TRACING_ENABLED
67
- : Enable sending traces. Default: ` false ` .
68
58
69
59
70
- -tracing-type | $OCS_TRACING_TYPE , $OCIS_TRACING_TYPE
71
- : Tracing backend type. Default: ` "jaeger" ` .
72
60
73
61
74
- -tracing-endpoint | $OCS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT
75
- : Endpoint for the agent. Default: ` "" ` .
76
62
77
63
78
- -tracing-collector | $OCS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR
79
- : Endpoint for the collector. Default: ` "" ` .
80
64
81
65
82
- -tracing-service | $OCS_TRACING_SERVICE
83
- : Service name for tracing. Default: ` "ocs" ` .
84
66
85
67
86
- -debug-addr | $OCS_DEBUG_ADDR
87
- : Address to bind debug server. Default: ` "0.0.0.0:9114" ` .
88
68
89
69
90
- -debug-token | $OCS_DEBUG_TOKEN
91
- : Token to grant metrics access. Default: ` "" ` .
92
70
93
71
94
- -debug-pprof | $OCS_DEBUG_PPROF
95
- : Enable pprof debugging.
96
72
97
73
98
- -debug-zpages | $OCS_DEBUG_ZPAGES
99
- : Enable zpages debugging.
74
+ ### ocs ocis-ocs
100
75
76
+ Serve OCS API for oCIS
101
77
102
- -http-addr | $OCS_HTTP_ADDR
103
- : Address to bind http server. Default: ` "0.0.0.0:9110" ` .
78
+ Usage: ` ocs ocis-ocs [command options] [arguments...] `
104
79
105
80
106
- -http-namespace | $OCS_NAMESPACE
107
- : Set the base namespace for the http namespace. Default: ` "com.owncloud.web" ` .
108
81
109
82
110
- -name | $OCS_NAME
111
- : Service name. Default: ` "ocs" ` .
112
83
113
84
114
- -http-root | $OCS_HTTP_ROOT
115
- : Root path of http server. Default: ` "/ocs" ` .
116
85
117
86
118
- -jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET
119
- : Used to dismantle the access token, should equal reva's jwt-secret. Default: ` "Pive-Fumkiu4" ` .
120
87
121
88
122
- -account-backend-type | $OCS_ACCOUNT_BACKEND_TYPE
123
- : account-backend-type. Default: ` "accounts" ` .
124
89
125
90
126
- -reva-gateway-addr | $OCS_REVA_GATEWAY_ADDR
127
- : REVA Gateway Endpoint. Default: ` "127.0.0.1:9142" ` .
128
91
129
92
130
- -idm-address | $OCS_IDM_ADDRESS , $OCIS_URL
131
- : keeps track of the IDM Address. Needed because of Reva requisite of uniqueness for users. Default: ` "https://localhost:9200" ` .
132
93
133
94
134
- -users-driver | $OCS_STORAGE_USERS_DRIVER , $STORAGE_USERS_DRIVER
135
- : storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: ` "ocis" ` .
136
95
137
96
138
- -extensions |
139
- : Run specific extensions during supervised mode.
140
97
141
98
142
99
143
- ### ocs version
144
100
145
- Print the versions of the running instances
146
101
147
- Usage: ` ocs version [command options] [arguments...] `
148
102
149
103
150
104
151
105
152
106
107
+ ### ocs server
153
108
109
+ Start integrated server
154
110
111
+ Usage: ` ocs server [command options] [arguments...] `
155
112
156
113
157
114
115
+ -log-file | $OCS_LOG_FILE , $OCIS_LOG_FILE
116
+ : Enable log to file.
158
117
159
118
119
+ -log-level | $OCS_LOG_LEVEL , $OCIS_LOG_LEVEL
120
+ : Set logging level.
160
121
161
122
123
+ -log-pretty | $OCS_LOG_PRETTY , $OCIS_LOG_PRETTY
124
+ : Enable pretty logging.
162
125
163
126
127
+ -log-color | $OCS_LOG_COLOR , $OCIS_LOG_COLOR
128
+ : Enable colored logging.
164
129
165
130
131
+ -config-file | $OCS_CONFIG_FILE
132
+ : Path to config file.
166
133
167
134
135
+ -tracing-enabled | $OCS_TRACING_ENABLED , $OCIS_TRACING_ENABLED
136
+ : Enable sending traces. Default: ` false ` .
168
137
169
138
139
+ -tracing-type | $OCS_TRACING_TYPE , $OCIS_TRACING_TYPE
140
+ : Tracing backend type. Default: ` "jaeger" ` .
170
141
171
142
143
+ -tracing-endpoint | $OCS_TRACING_ENDPOINT , $OCIS_TRACING_ENDPOINT
144
+ : Endpoint for the agent. Default: ` "" ` .
172
145
173
146
147
+ -tracing-collector | $OCS_TRACING_COLLECTOR , $OCIS_TRACING_COLLECTOR
148
+ : Endpoint for the collector. Default: ` "" ` .
174
149
175
- -http-namespace | $OCS_NAMESPACE
176
- : Set the base namespace for the http namespace. Default: ` "com.owncloud.web" ` .
177
150
151
+ -tracing-service | $OCS_TRACING_SERVICE
152
+ : Service name for tracing. Default: ` "ocs" ` .
178
153
179
- -name | $OCS_NAME
180
- : Service name. Default: ` "ocs" ` .
181
154
182
- ### ocs health
155
+ -debug-addr | $OCS_DEBUG_ADDR
156
+ : Address to bind debug server. Default: ` "0.0.0.0:9114" ` .
183
157
184
- Check health status
185
158
186
- Usage: ` ocs health [command options] [arguments...] `
159
+ -debug-token | $OCS_DEBUG_TOKEN
160
+ : Token to grant metrics access. Default: ` "" ` .
187
161
188
162
189
- -debug-addr | $OCS_DEBUG_ADDR
190
- : Address to debug endpoint. Default: ` "0.0.0.0:9114" ` .
163
+ -debug-pprof | $OCS_DEBUG_PPROF
164
+ : Enable pprof debugging .
191
165
192
166
167
+ -debug-zpages | $OCS_DEBUG_ZPAGES
168
+ : Enable zpages debugging.
193
169
194
170
171
+ -http-addr | $OCS_HTTP_ADDR
172
+ : Address to bind http server. Default: ` "0.0.0.0:9110" ` .
195
173
196
174
175
+ -http-namespace | $OCS_NAMESPACE
176
+ : Set the base namespace for the http namespace. Default: ` "com.owncloud.web" ` .
197
177
198
178
179
+ -name | $OCS_NAME
180
+ : Service name. Default: ` "ocs" ` .
199
181
200
182
183
+ -http-root | $OCS_HTTP_ROOT
184
+ : Root path of http server. Default: ` "/ocs" ` .
201
185
202
186
187
+ -jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET
188
+ : Used to dismantle the access token, should equal reva's jwt-secret. Default: ` "Pive-Fumkiu4" ` .
203
189
204
190
191
+ -account-backend-type | $OCS_ACCOUNT_BACKEND_TYPE
192
+ : account-backend-type. Default: ` "accounts" ` .
205
193
206
194
195
+ -reva-gateway-addr | $OCS_REVA_GATEWAY_ADDR
196
+ : REVA Gateway Endpoint. Default: ` "127.0.0.1:9142" ` .
207
197
208
198
199
+ -idm-address | $OCS_IDM_ADDRESS , $OCIS_URL
200
+ : keeps track of the IDM Address. Needed because of Reva requisite of uniqueness for users. Default: ` "https://localhost:9200" ` .
209
201
210
202
203
+ -users-driver | $OCS_STORAGE_USERS_DRIVER , $STORAGE_USERS_DRIVER
204
+ : storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: ` "ocis" ` .
211
205
212
206
207
+ -extensions |
208
+ : Run specific extensions during supervised mode.
213
209
214
210
215
211
212
+ ### ocs version
216
213
214
+ Print the versions of the running instances
217
215
218
- ### ocs ocis-ocs
216
+ Usage: ` ocs version [command options] [arguments...] `
219
217
220
- Serve OCS API for oCIS
221
218
222
- Usage: ` ocs ocis-ocs [command options] [arguments...] `
223
219
224
220
225
221
@@ -245,6 +241,10 @@ Usage: `ocs ocis-ocs [command options] [arguments...]`
245
241
246
242
247
243
244
+ -http-namespace | $OCS_NAMESPACE
245
+ : Set the base namespace for the http namespace. Default: ` "com.owncloud.web" ` .
248
246
249
247
248
+ -name | $OCS_NAME
249
+ : Service name. Default: ` "ocs" ` .
250
250
0 commit comments