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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59


# Autogenerated
# Filename: frontend-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9141
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9140
  protocol: tcp
  prefix: ""
transfer_secret: ""
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
machine_auth_api_key: ""
skip_user_groups_in_token: false
enable_favorites: false
enable_project_spaces: true
enable_share_jail: true
upload_max_chunk_size: 100000000
upload_http_method_override: ""
default_upload_protocol: tus
public_url: https://localhost:9200
app_handler:
  insecure: false
archiver:
  max_num_files: 10000
  max_size: 1073741824
  insecure: false
data_gateway:
  prefix: data
ocs:
  prefix: ocs
  share_prefix: /Shares
  home_namespace: /users/{{.Id.OpaqueId}}
  additional_info_attribute: '{{.Mail}}'
  resource_info_cache_ttl: 0
checksums:
  supported_types:
  - sha1
  - md5
  - adler32
  preferred_upload_type: ""
middleware:
  auth:
    credentials_by_user_agent: {}

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED FRONTEND_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE FRONTEND_TRACING_TYPE	string
OCIS_TRACING_ENDPOINT FRONTEND_TRACING_ENDPOINT	string		The endpoint to the tracing collector.
OCIS_TRACING_COLLECTOR FRONTEND_TRACING_COLLECTOR	string
OCIS_LOG_LEVEL FRONTEND_LOG_LEVEL	string		The log level.
OCIS_LOG_PRETTY FRONTEND_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR FRONTEND_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE FRONTEND_LOG_FILE	string		The target log file.
FRONTEND_DEBUG_ADDR	string	127.0.0.1:9141	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
FRONTEND_DEBUG_TOKEN	string		Token to secure the metrics endpoint
FRONTEND_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling
FRONTEND_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing traces in-me
FRONTEND_HTTP_ADDR	string	127.0.0.1:9140	The address of the http service.
FRONTEND_HTTP_PROTOCOL	string	tcp	The transport protocol of the http service.
FRONTEND_HTTP_PREFIX	string
STORAGE_TRANSFER_SECRET	string
OCIS_JWT_SECRET FRONTEND_JWT_SECRET	string
REVA_GATEWAY	string	127.0.0.1:9142
OCIS_MACHINE_AUTH_API_KEY FRONTEND_MACHINE_AUTH_API_KEY	string
FRONTEND_SKIP_USER_GROUPS_IN_TOKEN	bool	false
FRONTEND_ENABLE_FAVORITES	bool	false
FRONTEND_ENABLE_PROJECT_SPACES	bool	true	Indicates to clients that project spaces are supposed to be made available.
FRONTEND_ENABLE_SHARE_JAIL	bool	true	Indicates to clients that the share jail is supposed to be used.
FRONTEND_UPLOAD_MAX_CHUNK_SIZE	int	100000000
FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE	string
FRONTEND_DEFAULT_UPLOAD_PROTOCOL	string	tus
OCIS_URL FRONTEND_PUBLIC_URL	string	https://localhost:9200
OCIS_INSECURE FRONTEND_APP_HANDLER_INSECURE	bool	false
FRONTEND_ARCHIVER_MAX_NUM_FILES	int64	10000
FRONTEND_ARCHIVER_MAX_SIZE	int64	1073741824
OCIS_INSECURE FRONTEND_ARCHIVER_INSECURE	bool	false
FRONTEND_DATA_GATEWAY_PREFIX	string	data
FRONTEND_OCS_PREFIX	string	ocs
FRONTEND_OCS_SHARE_PREFIX	string	/Shares
FRONTEND_OCS_HOME_NAMESPACE	string	/users/{{.Id.OpaqueId}}
FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE	string	{{.Mail}}
FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL	int	0
FRONTEND_CHECKSUMS_SUPPORTED_TYPES		[sha1 md5 adler32]
FRONTEND_CHECKSUMS_PREFERRED_UPLOAD_TYPES	string