WebDAV Service Configuration

Introduction

The Infinite Scale WebDAV service provides preview (thumbnails) endpoints on the WebDAV API and therefore extends the main WebDAV API provided by the OCDAV service.

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

Environment variables for the webdav extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
WEBDAV_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
WEBDAV_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
WEBDAV_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
WEBDAV_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
WEBDAV_LOG_LEVEL

string

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

OCIS_LOG_PRETTY
WEBDAV_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
WEBDAV_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
WEBDAV_LOG_FILE

string

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

WEBDAV_DEBUG_ADDR

string

127.0.0.1:9119

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

WEBDAV_DEBUG_TOKEN

string

Token to secure the metrics endpoint

WEBDAV_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

WEBDAV_DEBUG_ZPAGES

bool

false

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

WEBDAV_HTTP_ADDR

string

127.0.0.1:9115

The bind address of the HTTP service.

WEBDAV_HTTP_ROOT

string

/

Subdirectory that serves as the root for this HTTP service.

OCIS_URL
OCIS_PUBLIC_URL

string

https://127.0.0.1:9200

URL, where oCIS is reachable for users.

WEBDAV_WEBDAV_NAMESPACE

string

/users/{{.Id.OpaqueId}}

CS3 path layout to use when forwarding /webdav requests

REVA_GATEWAY

string

127.0.0.1:9142

The CS3 gateway endpoint.

Since Version: + added, - deprecated

YAML Example

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9119
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9115
  root: /
  cors:
    allowed_origins:
    - '*'
    allowed_methods:
    - GET
    - POST
    - PUT
    - PATCH
    - DELETE
    - OPTIONS
    allowed_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    allow_credentials: true
ocis_public_url: https://127.0.0.1:9200
webdav_namespace: /users/{{.Id.OpaqueId}}
reva_gateway: 127.0.0.1:9142