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
42
43


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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9179
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9178
  tls: null
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: com.owncloud.api.gateway
  tls:
    mode: ""
    cacert: ""
brute_force:
  time_gap: 1h0m0s
  max_attempts: 5
store:
  store: nats-js-kv
  nodes:
  - 127.0.0.1:9233
  database: storage-publiclink
  table: brute-force-protection
  username: ""
  password: ""
skip_user_groups_in_token: false
storage_provider:
  mount_id: 7993447f-687f-490d-875c-ac95e89a62a4

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED STORAGE_PUBLICLINK_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE STORAGE_PUBLICLINK_TRACING_TYPE	string		The type of tracing. Defaults to ‘’, which is the same as ‘jaeger’. Allowed tracing types are ‘jaeger’, ‘otlp’ and ’’ as of now.
OCIS_TRACING_ENDPOINT STORAGE_PUBLICLINK_TRACING_ENDPOINT	string		The endpoint of the tracing agent.
OCIS_TRACING_COLLECTOR STORAGE_PUBLICLINK_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_PUBLICLINK_LOG_LEVEL	string		The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’.
OCIS_LOG_PRETTY STORAGE_PUBLICLINK_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR STORAGE_PUBLICLINK_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE STORAGE_PUBLICLINK_LOG_FILE	string		The path to the log file. Activates logging to this file if set.
STORAGE_PUBLICLINK_DEBUG_ADDR	string	127.0.0.1:9179	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
STORAGE_PUBLICLINK_DEBUG_TOKEN	string		Token to secure the metrics endpoint.
STORAGE_PUBLICLINK_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling.
STORAGE_PUBLICLINK_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
STORAGE_PUBLICLINK_GRPC_ADDR	string	127.0.0.1:9178	The bind address of the GRPC service.
OCIS_GRPC_PROTOCOL STORAGE_PUBLICLINK_GRPC_PROTOCOL	string	tcp	The transport protocol of the GRPC service.
OCIS_JWT_SECRET STORAGE_PUBLICLINK_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_PUBLICLINK_BRUTEFORCE_TIMEGAP	Duration	1h0m0s	The duration of the time gap computed for the brute force protection.
STORAGE_PUBLICLINK_BRUTEFORCE_MAXATTEMPTS	int	5	The maximum number of failed attempts allowed in the time gap defined in STORAGE_PUBLICLINK_BRUTEFORCE_TIMEGAP.
OCIS_PERSISTENT_STORE STORAGE_PUBLICLINK_STORE_STORE	string	nats-js-kv	The type of the store. Supported values are: ‘memory’, ’nats-js-kv’, ‘redis-sentinel’, ’noop’. See the text description for details.
OCIS_PERSISTENT_STORE_NODES STORAGE_PUBLICLINK_STORE_NODES	[]string	[127.0.0.1:9233]	A list of nodes to access the configured store. This has no effect when ‘memory’ store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details.
STORAGE_PUBLICLINK_STORE_DATABASE	string	storage-publiclink	The database name the configured store should use.
STORAGE_PUBLICLINK_STORE_TABLE	string	brute-force-protection	The database table the store should use.
OCIS_PERSISTENT_STORE_AUTH_USERNAME STORAGE_PUBLICLINK_STORE_AUTH_USERNAME	string		The username to authenticate with the store. Only applies when store type ’nats-js-kv’ is configured.
OCIS_PERSISTENT_STORE_AUTH_PASSWORD STORAGE_PUBLICLINK_STORE_AUTH_PASSWORD	string		The password to authenticate with the store. Only applies when store type ’nats-js-kv’ is configured.
STORAGE_PUBLICLINK_SKIP_USER_GROUPS_IN_TOKEN	bool	false	Disables the loading of user’s group memberships from the reva access token.
STORAGE_PUBLICLINK_STORAGE_PROVIDER_MOUNT_ID	string	7993447f-687f-490d-875c-ac95e89a62a4	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.