Thumbnails Service Configuration

Introduction

The Infinite Scale Thumbnails 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 thumbnails extension is configured via the following environment variables:

Environment variables for the thumbnails extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
THUMBNAILS_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
THUMBNAILS_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
THUMBNAILS_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
THUMBNAILS_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
THUMBNAILS_LOG_LEVEL

string

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

OCIS_LOG_PRETTY
THUMBNAILS_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
THUMBNAILS_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
THUMBNAILS_LOG_FILE

string

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

THUMBNAILS_DEBUG_ADDR

string

127.0.0.1:9189

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

THUMBNAILS_DEBUG_TOKEN

string

Token to secure the metrics endpoint

THUMBNAILS_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

THUMBNAILS_DEBUG_ZPAGES

bool

false

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

THUMBNAILS_GRPC_ADDR

string

127.0.0.1:9185

The address off the grpc service.

THUMBNAILS_HTTP_ADDR

string

127.0.0.1:9186

The bind address of the HTTP service.

THUMBNAILS_HTTP_ROOT

string

/thumbnails

Subdirectory that serves as the root for this HTTP service.

THUMBNAILS_RESOLUTIONS

The supported target resolutions in the format WidthxHeight e.g. 32x32. You can provide multiple resolutions seperated by a comma.

THUMBNAILS_FILESYSTEMSTORAGE_ROOT

string

~/.ocis/thumbnails

The directory where the filesystem storage will store the thumbnails.

OCIS_INSECURE
THUMBNAILS_WEBDAVSOURCE_INSECURE

bool

false

Ignore untrusted SSL certificates when connecting to the webdav source.

OCIS_INSECURE
THUMBNAILS_CS3SOURCE_INSECURE

bool

false

Ignore untrusted SSL certificates when connecting to the CS3 source.

REVA_GATEWAY

string

127.0.0.1:9142

The CS3 gateway endpoint.

THUMBNAILS_TXT_FONTMAP_FILE

string

The path to a font file for txt thumbnails.

THUMBNAILS_TRANSFER_TOKEN

string

The secret to sign JWT to download the actual thumbnail file.

THUMBNAILS_DATA_ENDPOINT

string

http://127.0.0.1:9186/thumbnails/data

The HTTP endpoint where the actual thumbnail file can be downloaded.

Since Version: + added, - deprecated

YAML Example

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9189
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9185
http:
  addr: 127.0.0.1:9186
  root: /thumbnails
thumbnail:
  resolutions:
  - 16x16
  - 32x32
  - 64x64
  - 128x128
  - 1920x1080
  - 3840x2160
  - 7680x4320
  filesystem_storage:
    root_directory: ~/.ocis/thumbnails
  webdav_allow_insecure: false
  cs3_allow_insecure: false
  reva_gateway: 127.0.0.1:9142
  font_map_file: ""
  transfer_secret: ""
  data_endpoint: http://127.0.0.1:9186/thumbnails/data