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
34
35
36
37
38
39
40
41


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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9217
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9215
  protocol: tcp
http:
  addr: 127.0.0.1:9216
  protocol: tcp
events:
  endpoint: ""
  cluster: ""
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
system_user_id: ""
system_user_api_key: ""
skip_user_groups_in_token: false
driver: ocis
drivers:
  ocis:
    root: ~/.ocis/storage/metadata
data_server_url: http://localhost:9216/data
temp_folder: ~/.ocis/tmp/metadata
data_provider_insecure: false

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED STORAGE_SYSTEM_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE STORAGE_SYSTEM_TRACING_TYPE	string
OCIS_TRACING_ENDPOINT STORAGE_SYSTEM_TRACING_ENDPOINT	string		The endpoint to the tracing collector.
OCIS_TRACING_COLLECTOR STORAGE_SYSTEM_TRACING_COLLECTOR	string
OCIS_LOG_LEVEL STORAGE_SYSTEM_LOG_LEVEL	string		The log level.
OCIS_LOG_PRETTY STORAGE_SYSTEM_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR STORAGE_SYSTEM_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE STORAGE_SYSTEM_LOG_FILE	string		The target log file.
STORAGE_SYSTEM_DEBUG_ADDR	string	127.0.0.1:9217	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
STORAGE_SYSTEM_DEBUG_TOKEN	string		Token to secure the metrics endpoint
STORAGE_SYSTEM_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling
STORAGE_SYSTEM_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing traces in-me
STORAGE_SYSTEM_GRPC_ADDR	string	127.0.0.1:9215	The address of the grpc service.
STORAGE_SYSTEM_GRPC_PROTOCOL	string	tcp	The transport protocol of the grpc service.
STORAGE_SYSTEM_HTTP_ADDR	string	127.0.0.1:9216	The address of the http service.
STORAGE_SYSTEM_HTTP_PROTOCOL	string	tcp	The transport protocol of the http service.
STORAGE_SYSTEM_EVENTS_ENDPOINT	string		the address of the streaming service
STORAGE_SYSTEM_EVENTS_CLUSTER	string		the clusterID of the streaming service. Mandatory when using nats
OCIS_JWT_SECRET STORAGE_SYSTEM_JWT_SECRET	string
REVA_GATEWAY	string	127.0.0.1:9142
OCIS_SYSTEM_USER_ID	string
OCIS_SYSTEM_USER_API_KEY	string
STORAGE_SYSTEM_SKIP_USER_GROUPS_IN_TOKEN	bool	false
STORAGE_SYSTEM_DRIVER	string	ocis	The driver which should be used by the service
STORAGE_SYSTEM_OCIS_ROOT	string	~/.ocis/storage/metadata
STORAGE_SYSTEM_DATA_SERVER_URL	string	http://localhost:9216/data
STORAGE_SYSTEM_TEMP_FOLDER	string	~/.ocis/tmp/metadata
OCIS_INSECURE STORAGE_SYSTEM_DATAPROVIDER_INSECURE	bool	false