OCS Service Configuration

Introduction

The Infinite Scale OCS service provides the OCS API which is required by some ownCloud clients.

Services are under development because of the beta badge 1 stage of Infinite Scale. Their service, environment variables and configuration may change. Forgive us if there are mistakes or information is missing. Feel free to report issues and we’ll take care of them as soon as possible on github. You want to fix them yourself? We’d appreciate that even more.

Configuration

Environment Variables

The ocs extension is configured via the following environment variables:

Environment variables for the ocs extension
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_JWT_SECRET
OCS_JWT_SECRET

string

The secret to mint and validate jwt tokens.

REVA_GATEWAY

string

127.0.0.1:9142

The CS3 gateway endpoint.

OCIS_URL
OCIS_OIDC_ISSUER
OCS_IDM_ADDRESS

string

https://localhost:9200

URL of the OIDC issuer. It defaults to URL of the builtin IDP.

OCIS_MACHINE_AUTH_API_KEY
OCS_MACHINE_AUTH_API_KEY

string

Machine auth API key used for accessing the 'auth-machine' service to impersonate users.

Since Version: + added, - deprecated

YAML Example

# 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:
    allowed_origins:
    - '*'
    allowed_methods:
    - GET
    - POST
    - PUT
    - PATCH
    - DELETE
    - OPTIONS
    allowed_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    allowed_credentials: true
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
identity_management:
  address: https://localhost:9200
machine_auth_api_key: ""