Settings Service Configuration

Introduction

The Infinite Scale Settings service provides …​

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 settings extension is configured via the following environment variables:

Environment variables for the settings extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
SETTINGS_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
SETTINGS_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
SETTINGS_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
SETTINGS_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
SETTINGS_LOG_LEVEL

string

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

OCIS_LOG_PRETTY
SETTINGS_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
SETTINGS_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
SETTINGS_LOG_FILE

string

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

SETTINGS_DEBUG_ADDR

string

127.0.0.1:9194

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

SETTINGS_DEBUG_TOKEN

string

Token to secure the metrics endpoint

SETTINGS_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

SETTINGS_DEBUG_ZPAGES

bool

false

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

SETTINGS_HTTP_ADDR

string

127.0.0.1:9190

The bind address of the HTTP service.

SETTINGS_HTTP_ROOT

string

/

Subdirectory that serves as the root for this HTTP service.

SETTINGS_CACHE_TTL

int

604800

Browser cache control max-age value in seconds for settings Web UI assets.

SETTINGS_GRPC_ADDR

string

127.0.0.1:9191

The bind address of the GRPC service.

SETTINGS_STORE_TYPE

string

metadata

Store type configures the persistency driver. Possible values are "metadata" and "filesystem".

SETTINGS_DATA_PATH

string

~/.ocis/settings

Path for the persistence directory.

STORAGE_GATEWAY_GRPC_ADDR

string

127.0.0.1:9215

GRPC address of the storage-system service.

STORAGE_GRPC_ADDR

string

127.0.0.1:9215

GRPC address of the storage-system service.

OCIS_SYSTEM_USER_ID
SETTINGS_SYSTEM_USER_ID

string

ID of the oCIS storage-system system user. Admins need to set the ID for the storage-system system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.

OCIS_SYSTEM_USER_IDP
SETTINGS_SYSTEM_USER_IDP

string

internal

IDP of the oCIS storage-system system user.

OCIS_SYSTEM_USER_API_KEY

string

API key for the storage-system system user.

OCIS_ADMIN_USER_ID
SETTINGS_ADMIN_USER_ID

string

ID of a user, that should receive admin privileges.

SETTINGS_ASSET_PATH

string

Serve settings Web UI assets from a path on the filesystem instead of the builtin assets. Can be used for development and customization.

OCIS_JWT_SECRET
SETTINGS_JWT_SECRET

string

The secret to mint and validate jwt tokens.

SETTINGS_SETUP_DEFAULT_ASSIGNMENTS
ACCOUNTS_DEMO_USERS_AND_GROUPS

bool

false

If the default role assignments for the demo users should be setup.

Since Version: + added, - deprecated

YAML Example

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9194
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9190
  root: /
  cache_ttl: 604800
  cors:
    allowed_origins:
    - '*'
    allowed_methods:
    - GET
    - POST
    - PUT
    - PATCH
    - DELETE
    - OPTIONS
    allowed_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    allowed_credentials: true
grpc:
  addr: 127.0.0.1:9191
store_type: metadata
data_path: ~/.ocis/settings
metadata_config:
  gateway_addr: 127.0.0.1:9215
  storage_addr: 127.0.0.1:9215
  system_user_id: ""
  system_user_idp: internal
  system_user_api_key: ""
admin_user_id: ""
asset:
  path: ""
token_manager:
  jwt_secret: ""
set_default_assignments: false