OCS Service Configuration

Introduction

The Infinite Scale OCS service (open collaboration services) serves mainly one purpose: it has an endpoint for signing keys which the web frontend accesses when uploading data.

Default Values

  • OCS listens on port 9110 by default.

Signing-Keys Endpoint

The ocs service provides an endpoint /cloud/user/signing-key which is accessed from the web frontend via GET to request a signing key used for uploads.

Signing-Keys Store

To authenticate presigned URLs, the proxy service needs to read the signing keys from a store that is populated by the ocs service.

The following stores can be configured via the OCS_PRESIGNEDURL_SIGNING_KEYS_STORE environment variable:

  • nats-js-kv
    Stores data using key-value-store feature of nats jetstream.

  • redis-sentinel
    Stores data in a configured Redis Sentinel cluster.

  • ocisstoreservice
    Stores data in the deprecated Infinite Scale store service.
    Requires setting OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES to com.owncloud.api.store.

  • The memory or ocmem stores cannot be used as they do not share the memory from the ocs service signing key memory store, even in a single process.

  • Make sure to configure the same store in the proxy service.

Store specific notes:

  • When using redis-sentinel
    The Redis master to use is configured via e.g. OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES in the form of <sentinel-host>:<sentinel-port>/<redis-master> like 10.10.0.200:26379/mymaster.

  • When using nats-js-kv
    It is recommended to set PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES to the same value as OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES. That way the proxy service uses the same nats instance as the ocs service.

  • When using ocisstoreservice
    The OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES must be set to the service name com.owncloud.api.store. It does not support TTL and stores the presigning keys indefinitely. Also, the store service needs to be started.

Configuration

Environment Variables

The ocs service is configured via the following environment variables. Read the Environment Variable Types documentation for important details.

  • 5.0.2

Environment variables for the ocs service
Name Type Default Value Description

OCIS_TRACING_ENABLED
OCS_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
OCS_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
OCS_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
OCS_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
OCS_LOG_LEVEL

string

The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.

OCIS_LOG_PRETTY
OCS_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
OCS_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
OCS_LOG_FILE

string

The path to the log file. Activates logging to this file if set.

OCS_DEBUG_ADDR

string

127.0.0.1:9114

Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.

OCS_DEBUG_TOKEN

string

Token to secure the metrics endpoint.

OCS_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling.

OCS_DEBUG_ZPAGES

bool

false

Enables zpages, which can be used for collecting and viewing in-memory traces.

OCS_HTTP_ADDR

string

127.0.0.1:9110

The bind address of the HTTP service.

OCS_HTTP_ROOT

string

/ocs

Subdirectory that serves as the root for this HTTP service.

OCIS_CORS_ALLOW_ORIGINS
OCS_CORS_ALLOW_ORIGINS

[]string

[*]

A 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. See the Environment Variable Types description for more details.

OCIS_CORS_ALLOW_METHODS
OCS_CORS_ALLOW_METHODS

[]string

[GET POST PUT PATCH DELETE OPTIONS]

A 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. See the Environment Variable Types description for more details.

OCIS_CORS_ALLOW_HEADERS
OCS_CORS_ALLOW_HEADERS

[]string

[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Cache-Control]

A 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. See the Environment Variable Types description for more details.

OCIS_CORS_ALLOW_CREDENTIALS
OCS_CORS_ALLOW_CREDENTIALS

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.

OCIS_HTTP_TLS_ENABLED

bool

false

Activates TLS for the http based services using the server certifcate and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.

OCIS_HTTP_TLS_CERTIFICATE

string

Path/File name of the TLS server certificate (in PEM format) for the http services.

OCIS_HTTP_TLS_KEY

string

Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.

OCIS_CACHE_STORE
OCS_PRESIGNEDURL_SIGNING_KEYS_STORE

string

nats-js-kv

The type of the signing key store. Supported values are: 'redis-sentinel' and 'nats-js-kv'. See the text description for details.

OCIS_CACHE_STORE_NODES
OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES

[]string

[127.0.0.1:9233]

A list of nodes to access the configured store. 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.

OCIS_CACHE_TTL
OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL

Duration

12h0m0s

Default time to live for signing keys. See the Environment Variable Types description for more details.

OCIS_CACHE_AUTH_USERNAME
OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME

string

The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.

OCIS_CACHE_AUTH_PASSWORD
OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD

string

The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.

OCIS_JWT_SECRET
OCS_JWT_SECRET

string

The secret to mint and validate jwt tokens.

YAML Example

  • 5.0.2

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9114
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9110
  root: /ocs
  cors:
    allow_origins:
    - '*'
    allow_methods:
    - GET
    - POST
    - PUT
    - PATCH
    - DELETE
    - OPTIONS
    allow_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    - X-Request-Id
    - Cache-Control
    allow_credentials: true
  tls:
    enabled: false
    cert: ""
    key: ""
grpc_client_tls: null
signing_keys:
  store: nats-js-kv
  addresses:
  - 127.0.0.1:9233
  ttl: 12h0m0s
  username: ""
  password: ""
token_manager:
  jwt_secret: ""