App Provider Service Configuration

Table of Contents

Introduction
Configuration
- Environment Variables
- YAML Example

Introduction

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

Services 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 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		The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.
`OCIS_TRACING_ENDPOINT` `APP_PROVIDER_TRACING_ENDPOINT`	string		The endpoint of the tracing agent.
`OCIS_TRACING_COLLECTOR` `APP_PROVIDER_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` `APP_PROVIDER_LOG_LEVEL`	string		The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".
`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 path to the log file. Activates logging to this file if set.
`APP_PROVIDER_DEBUG_ADDR`	string	127.0.0.1:9165	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
`APP_PROVIDER_DEBUG_TOKEN`	string		Token to secure the metrics endpoint
`APP_PROVIDER_DEBUG_PPROF`	bool	false	Enables pprof, which can be used for profiling
`APP_PROVIDER_DEBUG_ZPAGES`	bool	false	Enables zpages, which can be used for collecting and viewing traces in-memory.
`APP_PROVIDER_GRPC_ADDR`	string	127.0.0.1:9164	The bind 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		The secret to mint and validate jwt tokens.
`REVA_GATEWAY`	string	127.0.0.1:9142	The CS3 gateway endpoint.
`APP_PROVIDER_EXTERNAL_ADDR`	string		Address of the app provider, where the gateway service can reach it.
`APP_PROVIDER_DRIVER`	string		Driver, which the app provider uses. Only "wopi" is supported as of now.
`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: ""