Frontend Service Configuration
Endpoints Overview
Currently, the frontend service handles requests for three functionalities, which are
-
datagateway and
-
ocs.
appprovider
The appprovider endpoint, by default /app
, forwards HTTP requests to the CS3 App Registry API.
archiver
The archiver endpoint, by default /archiver
, implements zip and tar download for collections of files. It will internally use the CS3 API to initiate downloads and then stream the individual files as part of a compressed file.
datagateway
The datagateway endpoint, by default /data
, forwards file up- and download requests to the correct CS3 data provider. OCIS starts a dataprovider as part of the storage-* services. The routing happens based on the JWT that was created by a storage provider in response to an InitiateFileDownload
or InitiateFileUpload
request.
ocs
The ocs endpoint, by default /ocs
, implements the ownCloud 10 Open Collaboration Services API by translating it into CS3 API requests. It can handle users, groups, capabilities and also implements the file sharing functionality on top of CS3. The /ocs/v[12].php/cloud/user/signing-key
is currently handled by the dedicated ocs service.
Scalability
While the frontend service does not persist any data, it does cache Stat()
responses and user information. Therefore, multiple instances of this service can be spawned in a bigger deployment like when using container orchestration with Kubernetes, when configuring FRONTEND_OCS_RESOURCE_INFO_CACHE_TYPE=redis
and the related config options.
Configuration
Environment Variables
The frontend
service is configured via the following environment variables:
Name | Type | Default Value | Description |
---|---|---|---|
|
bool |
false |
Activates tracing. |
|
string |
|
The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. |
|
string |
|
The endpoint of the tracing agent. |
|
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. |
|
string |
|
The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". |
|
bool |
false |
Activates pretty log output. |
|
bool |
false |
Activates colorized log output. |
|
string |
|
The path to the log file. Activates logging to this file if set. |
|
string |
127.0.0.1:9141 |
Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. |
|
string |
|
Token to secure the metrics endpoint. |
|
bool |
false |
Enables pprof, which can be used for profiling. |
|
bool |
false |
Enables zpages, which can be used for collecting and viewing in-memory traces. |
|
string |
127.0.0.1:9140 |
The bind address of the HTTP service. |
|
string |
tcp |
The transport protocol of the HTTP service. |
|
string |
|
The Path prefix where the frontend can be accessed (defaults to /). |
|
[]string |
[*] |
A comma-separated list of allowed CORS origins. See following chapter for more details: Access-Control-Allow-Origin at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin |
|
[]string |
[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY REPORT SEARCH] |
A comma-separated list of allowed CORS methods. See following chapter for more details: Access-Control-Request-Method at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method |
|
[]string |
[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires Upload-Checksum Upload-Offset X-HTTP-Method-Override] |
A comma-separated list of allowed CORS headers. See following chapter for more details: Access-Control-Request-Headers at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. |
|
bool |
true |
Allow credentials for CORS.See following chapter for more details: Access-Control-Allow-Credentials at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials. |
|
string |
|
Transfer secret for signing file up- and download requests. |
|
string |
|
The secret to mint and validate jwt tokens. |
|
string |
127.0.0.1:9142 |
The CS3 gateway endpoint. |
|
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 to use transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server ceritificate verification. |
|
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. |
|
string |
|
The machine auth API key used to validate internal requests necessary to access resources from other services. |
|
bool |
false |
Disables the loading of user’s group memberships from the reva access token. |
|
bool |
false |
Enables the support for favorites in the clients. |
|
bool |
true |
Changing this value is NOT supported. Indicates to clients that project spaces are supposed to be made available. |
|
bool |
true |
Changing this value is NOT supported. Indicates to clients that the share jail is supposed to be used. |
|
uint64 |
0 |
Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. |
|
int |
100000000 |
Sets the max chunk sizes in bytes for uploads via the clients. |
|
string |
|
Advise TUS to replace PATCH requests by POST requests. |
|
string |
tus |
The default upload protocol to use in the clients (e.g. tus). |
|
bool |
true |
Changing this value is NOT supported. Enables the support for resharing in the clients. |
|
bool |
false |
Changing this value is NOT supported. Enables support for incoming federated sharing for clients. The backend behaviour is not changed. |
|
bool |
false |
Changing this value is NOT supported. Enables support for outgoing federated sharing for clients. The backend behaviour is not changed. |
|
int |
3 |
Minimum number of characters to enter before a client should start a search for Share receivers. This setting can be used to customize the user experience if e.g too many results are displayed. |
|
string |
https://localhost:9200 |
The public facing URL of the oCIS frontend. |
|
bool |
false |
Allow insecure connections to the frontend. |
|
int64 |
10000 |
Max number of files that can be packed into an archive. |
|
int64 |
1073741824 |
Max size in bytes of the zip archive the archiver can create. |
|
bool |
false |
Allow insecure connections to the archiver. |
|
string |
data |
Path prefix for the data gateway. |
|
string |
ocs |
URL path prefix for the OCS service. Note that the string must not start with '/'. |
|
string |
/Shares |
Path prefix for shares as part of an ocis resource. Note that the path must start with '/'. |
|
string |
/users/{{.Id.OpaqueId}} |
Homespace namespace identifier. |
|
string |
{{.Mail}} |
Additional information attribute for the user like {{.Mail}}. |
|
int |
0 |
Max TTL in seconds for the resource info cache. 0 disables the cache. |
|
string |
memory |
The type of the resource info cache. Supported values are 'memory' and 'redis'. |
|
string |
|
A comma separated list of addresses to access the configured store. This has no effect when the 'memory' store is configured. Note that the behaviour how addresses are used is dependent on the library of the configured store. |
|
string |
|
The username to access the redis cache. |
|
string |
|
The password to access the redis cache. |
|
bool |
false |
EXPERIMENTAL: enable the feature to deny access on folders. |
|
bool |
false |
Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. |
|
[]string |
[sha1 md5 adler32] |
Define the checksum types that indicate to clients which hashes the server can use to verify upload integrity. You can provide multiple types separated by blank or comma. Supported types are 'sha1', 'md5' and 'adler32'. |
|
string |
sha1 |
The supported checksum type for uploads that indicates to clients supporting multiple hash algorithms which one is preferred by the server. Must be one out of the defined list of SUPPORTED_TYPES. |
Name | Type | Default Value | Description |
---|---|---|---|
|
bool |
false |
Activates tracing. |
|
string |
|
The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. |
|
string |
|
The endpoint of the tracing agent. |
|
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. |
|
string |
|
The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". |
|
bool |
false |
Activates pretty log output. |
|
bool |
false |
Activates colorized log output. |
|
string |
|
The path to the log file. Activates logging to this file if set. |
|
string |
127.0.0.1:9141 |
Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. |
|
string |
|
Token to secure the metrics endpoint. |
|
bool |
false |
Enables pprof, which can be used for profiling. |
|
bool |
false |
Enables zpages, which can be used for collecting and viewing in-memory traces. |
|
string |
127.0.0.1:9140 |
The bind address of the HTTP service. |
|
string |
tcp |
The transport protocol of the HTTP service. |
|
string |
|
The Path prefix where the frontend can be accessed (defaults to /). |
|
[]string |
[*] |
A comma-separated list of allowed CORS origins. See following chapter for more details: Access-Control-Allow-Origin at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin |
|
[]string |
[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY REPORT SEARCH] |
A comma-separated list of allowed CORS methods. See following chapter for more details: Access-Control-Request-Method at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method |
|
[]string |
[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires Upload-Checksum Upload-Offset X-HTTP-Method-Override] |
A comma-separated list of allowed CORS headers. See following chapter for more details: Access-Control-Request-Headers at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. |
|
bool |
true |
Allow credentials for CORS.See following chapter for more details: Access-Control-Allow-Credentials at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials. |
|
string |
|
Transfer secret for signing file up- and download requests. |
|
string |
|
The secret to mint and validate jwt tokens. |
|
string |
127.0.0.1:9142 |
The CS3 gateway endpoint. |
|
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 to use transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server ceritificate verification. |
|
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. |
|
string |
|
The machine auth API key used to validate internal requests necessary to access resources from other services. |
|
bool |
false |
Disables the loading of user’s group memberships from the reva access token. |
|
bool |
false |
Enables the support for favorites in the clients. |
|
bool |
true |
Changing this value is NOT supported. Indicates to clients that project spaces are supposed to be made available. |
|
bool |
true |
Changing this value is NOT supported. Indicates to clients that the share jail is supposed to be used. |
|
int |
100000000 |
Sets the max chunk sizes in bytes for uploads via the clients. |
|
string |
|
Advise TUS to replace PATCH requests by POST requests. |
|
string |
tus |
The default upload protocol to use in the clients (e.g. tus). |
|
bool |
true |
Changing this value is NOT supported. Enables the support for resharing in the clients. |
|
bool |
false |
Changing this value is NOT supported. Enables support for incoming federated sharing for clients. The backend behaviour is not changed. |
|
bool |
false |
Changing this value is NOT supported. Enables support for outgoing federated sharing for clients. The backend behaviour is not changed. |
|
int |
3 |
Minimum number of characters to enter before a client should start a search for Share receivers. This setting can be used to customize the user experience if e.g too many results are displayed. |
|
string |
https://localhost:9200 |
The public facing URL of the oCIS frontend. |
|
bool |
false |
Allow insecure connections to the frontend. |
|
int64 |
10000 |
Max number of files that can be packed into an archive. |
|
int64 |
1073741824 |
Max size in bytes of the zip archive the archiver can create. |
|
bool |
false |
Allow insecure connections to the archiver. |
|
string |
data |
Path prefix for the data gateway. |
|
string |
ocs |
Path prefix for the OCS service |
|
string |
/Shares |
Path prefix for shares. |
|
string |
/users/{{.Id.OpaqueId}} |
Homespace namespace identifier. |
|
string |
{{.Mail}} |
Additional information attribute for the user like {{.Mail}}. |
|
int |
0 |
Max TTL in seconds for the resource info cache. 0 disables the cache. |
|
string |
memory |
Resource info cache type. Supported values are 'memory' and 'redis'. |
|
string |
|
Redis service address |
|
string |
|
Redis username |
|
string |
|
Redis password |
|
bool |
false |
EXPERIMENTAL: enable the feature to deny access on folders. |
|
[]string |
[sha1 md5 adler32] |
Define the checksum types that indicate to clients which hashes the server can use to verify upload integrity. You can provide multiple types separated by blank or comma. Supported types are 'sha1', 'md5' and 'adler32'. |
|
string |
sha1 |
The supported checksum type for uploads that indicates to clients supporting multiple hash algorithms which one is preferred by the server. Must be one out of the defined list of SUPPORTED_TYPES. |
YAML Example
Note that the filename shown below has been chosen on purpose.
See the Configuration File Naming for details when setting up your own configuration.
# 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: ""
cors:
allow_origins:
- '*'
allow_methods:
- OPTIONS
- HEAD
- GET
- PUT
- POST
- DELETE
- MKCOL
- PROPFIND
- PROPPATCH
- MOVE
- COPY
- REPORT
- SEARCH
allow_headers:
- Origin
- Accept
- Content-Type
- Depth
- Authorization
- Ocs-Apirequest
- If-None-Match
- If-Match
- Destination
- Overwrite
- X-Request-Id
- X-Requested-With
- Tus-Resumable
- Tus-Checksum-Algorithm
- Upload-Concat
- Upload-Length
- Upload-Metadata
- Upload-Defer-Length
- Upload-Expires
- Upload-Checksum
- Upload-Offset
- X-HTTP-Method-Override
allow_credentials: true
transfer_secret: ""
token_manager:
jwt_secret: ""
reva:
address: 127.0.0.1:9142
tls:
mode: ""
cacert: ""
machine_auth_api_key: ""
skip_user_groups_in_token: false
enable_favorites: false
enable_project_spaces: true
enable_share_jail: true
max_quota: 0
upload_max_chunk_size: 100000000
upload_http_method_override: ""
default_upload_protocol: tus
enable_resharing: true
enable_federated_sharing_incoming: false
enable_federated_sharing_outgoing: false
search_min_length: 3
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
resource_info_cache_type: memory
enable_denials: false
public_sharing_writeableshare_must_have_password: false
checksums:
supported_types:
- sha1
- md5
- adler32
preferred_upload_type: sha1
middleware:
auth:
credentials_by_user_agent: {}
# 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: ""
cors:
allow_origins:
- '*'
allow_methods:
- OPTIONS
- HEAD
- GET
- PUT
- POST
- DELETE
- MKCOL
- PROPFIND
- PROPPATCH
- MOVE
- COPY
- REPORT
- SEARCH
allow_headers:
- Origin
- Accept
- Content-Type
- Depth
- Authorization
- Ocs-Apirequest
- If-None-Match
- If-Match
- Destination
- Overwrite
- X-Request-Id
- X-Requested-With
- Tus-Resumable
- Tus-Checksum-Algorithm
- Upload-Concat
- Upload-Length
- Upload-Metadata
- Upload-Defer-Length
- Upload-Expires
- Upload-Checksum
- Upload-Offset
- X-HTTP-Method-Override
allow_credentials: true
transfer_secret: ""
token_manager:
jwt_secret: ""
reva:
address: 127.0.0.1:9142
tls:
mode: ""
cacert: ""
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
enable_resharing: true
enable_federated_sharing_incoming: false
enable_federated_sharing_outgoing: false
search_min_length: 3
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
resource_info_cache_type: memory
enable_denials: false
checksums:
supported_types:
- sha1
- md5
- adler32
preferred_upload_type: sha1
middleware:
auth:
credentials_by_user_agent: {}