Service Configuration

Example YAML Config

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33


# Autogenerated
# Filename: storage-shares-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9156
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9154
  tls: null
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: com.owncloud.api.gateway
  tls:
    mode: ""
    cacert: ""
skip_user_groups_in_token: false
mount_id: 7639e57c-4433-4a12-8201-722fd0009154
readonly: false
user_share_provider_endpoint: com.owncloud.api.sharing

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED STORAGE_SHARES_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE STORAGE_SHARES_TRACING_TYPE	string		The type of tracing. Defaults to ‘’, which is the same as ‘jaeger’. Allowed tracing types are ‘jaeger’ and ’’ as of now.
OCIS_TRACING_ENDPOINT STORAGE_SHARES_TRACING_ENDPOINT	string		The endpoint of the tracing agent.
OCIS_TRACING_COLLECTOR STORAGE_SHARES_TRACING_COLLECTOR	string		The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.
OCIS_LOG_LEVEL STORAGE_SHARES_LOG_LEVEL	string		The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’.
OCIS_LOG_PRETTY STORAGE_SHARES_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR STORAGE_SHARES_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE STORAGE_SHARES_LOG_FILE	string		The path to the log file. Activates logging to this file if set.
STORAGE_SHARES_DEBUG_ADDR	string	127.0.0.1:9156	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
STORAGE_SHARES_DEBUG_TOKEN	string		Token to secure the metrics endpoint.
STORAGE_SHARES_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling.
STORAGE_SHARES_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
STORAGE_SHARES_GRPC_ADDR	string	127.0.0.1:9154	The bind address of the GRPC service.
STORAGE_SHARES_GRPC_PROTOCOL	string	tcp	The transport protocol of the GRPC service.
OCIS_JWT_SECRET STORAGE_SHARES_JWT_SECRET	string		The secret to mint and validate jwt tokens.
OCIS_REVA_GATEWAY	string	com.owncloud.api.gateway	The CS3 gateway endpoint.
OCIS_GRPC_CLIENT_TLS_MODE	string		TLS mode for grpc connection to the go-micro based grpc services. Possible values are ‘off’, ‘insecure’ and ‘on’. ‘off’: disables transport security for the clients. ‘insecure’ allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). ‘on’ enables transport security, including server certificate verification.
OCIS_GRPC_CLIENT_TLS_CACERT	string		Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.
STORAGE_SHARES_SKIP_USER_GROUPS_IN_TOKEN	bool	false	Disables the loading of user’s group memberships from the reva access token.
STORAGE_SHARES_MOUNT_ID	string	7639e57c-4433-4a12-8201-722fd0009154	Mount ID of this storage. Admins can set the ID for the storage in this config option manually which is then used to reference the storage. Any reasonable long string is possible, preferably this would be an UUIDv4 format.
STORAGE_SHARES_READ_ONLY	bool	false	Set this storage to be read-only.
STORAGE_SHARES_USER_SHARE_PROVIDER_ENDPOINT	string	com.owncloud.api.sharing	GRPC endpoint of the SHARING service.