Settings Extension Configuration

Table of Contents

Introduction
Configuration
- Environment Variables
- YAML Example

Introduction

The Infinite Scale Settings extension provides …

Extensions are under development because of the

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
`OCIS_TRACING_TYPE` `SETTINGS_TRACING_TYPE`	string
`OCIS_TRACING_ENDPOINT` `SETTINGS_TRACING_ENDPOINT`	string
`OCIS_TRACING_COLLECTOR` `SETTINGS_TRACING_COLLECTOR`	string
`OCIS_LOG_LEVEL` `SETTINGS_LOG_LEVEL`	string
`OCIS_LOG_PRETTY` `SETTINGS_LOG_PRETTY`	bool	false
`OCIS_LOG_COLOR` `SETTINGS_LOG_COLOR`	bool	false
`OCIS_LOG_FILE` `SETTINGS_LOG_FILE`	string
`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 traces in-me
`SETTINGS_HTTP_ADDR`	string	127.0.0.1:9190
`SETTINGS_HTTP_ROOT`	string	/
`SETTINGS_CACHE_TTL`	int	604800
`SETTINGS_GRPC_ADDR`	string	127.0.0.1:9191
`SETTINGS_STORE_TYPE`	string	metadata
`SETTINGS_DATA_PATH`	string	~/.ocis/settings
`STORAGE_GATEWAY_GRPC_ADDR`	string	127.0.0.1:9215
`STORAGE_GRPC_ADDR`	string	127.0.0.1:9215
`OCIS_SYSTEM_USER_ID` `SETTINGS_SYSTEM_USER_ID`	string
`OCIS_SYSTEM_USER_IDP` `SETTINGS_SYSTEM_USER_IDP`	string	internal
`OCIS_SYSTEM_USER_API_KEY`	string
`OCIS_ADMIN_USER_ID` `SETTINGS_ADMIN_USER_ID`	string
`SETTINGS_ASSET_PATH`	string
`OCIS_JWT_SECRET` `SETTINGS_JWT_SECRET`	string

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: ""