App Provider Extension Configuration

Introduction

App providers represent apps, if the app is not able to register itself. Currently there is only the CS3org WOPI server app provider.

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

Environment variables for the app-provider extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
APP_PROVIDER_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
APP_PROVIDER_TRACING_TYPE

string

OCIS_TRACING_ENDPOINT
APP_PROVIDER_TRACING_ENDPOINT

string

The endpoint to the tracing collector.

OCIS_TRACING_COLLECTOR
APP_PROVIDER_TRACING_COLLECTOR

string

OCIS_LOG_LEVEL
APP_PROVIDER_LOG_LEVEL

string

The log level.

OCIS_LOG_PRETTY
APP_PROVIDER_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
APP_PROVIDER_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
APP_PROVIDER_LOG_FILE

string

The target log file.

APP_PROVIDER_DEBUG_ADDR

string

127.0.0.1:9165

APP_PROVIDER_DEBUG_TOKEN

string

APP_PROVIDER_DEBUG_PPROF

bool

false

APP_PROVIDER_DEBUG_ZPAGES

bool

false

APP_PROVIDER_GRPC_ADDR

string

127.0.0.1:9164

The address of the grpc service.

APP_PROVIDER_GRPC_PROTOCOL

string

tcp

The transport protocol of the grpc service.

OCIS_JWT_SECRET
APP_PROVIDER_JWT_SECRET

string

REVA_GATEWAY

string

127.0.0.1:9142

APP_PROVIDER_EXTERNAL_ADDR

string

APP_PROVIDER_DRIVER

string

APP_PROVIDER_WOPI_APP_API_KEY

string

api key for the wopi app

APP_PROVIDER_WOPI_APP_DESKTOP_ONLY

bool

false

offer this app only on desktop

APP_PROVIDER_WOPI_APP_ICON_URI

string

uri to an app icon to be used by clients

APP_PROVIDER_WOPI_APP_INTERNAL_URL

string

internal url to the app, eg in your DMZ

APP_PROVIDER_WOPI_APP_NAME

string

human readable app name

APP_PROVIDER_WOPI_APP_URL

string

url for end users to access the app

APP_PROVIDER_WOPI_INSECURE

bool

false

allow insecure connections to the app

APP_PROVIDER_WOPI_WOPI_SERVER_IOP_SECRET

string

shared secret of the CS3org WOPI server

APP_PROVIDER_WOPI_WOPI_SERVER_EXTERNAL_URL

string

external url of the CS3org WOPI server

Since Version: + added, - deprecated

YAML Example

# Autogenerated
# Filename: app-provider-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9165
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9164
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
external_addr: ""
driver: ""
drivers:
  wopi:
    app_api_key: ""
    app_desktop_only: false
    app_icon_uri: ""
    app_internal_url: ""
    app_name: ""
    app_url: ""
    insecure: false
    wopi_server_iop_secret: ""
    wopi_server_external_url: ""