Configuration

Configuration

Configuration using config files

Out of the box extensions will attempt to read configuration details from:

/etc/ocis
$HOME/.ocis
./config

For this configuration to be picked up, have a look at your extension root command and look for which default config name it has assigned. i.e: ocis-web reads web.json | yaml | toml ....

So far we support the file formats JSON and YAML, if you want to get a full example configuration just take a look at our repository, there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it’s placed at /etc/ocis/ocis.yml, ${HOME}/.ocis/ocis.yml or $(pwd)/config/ocis.yml.

Environment variables

If you prefer to configure the service with environment variables you can see the available variables below.

If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given.

Commandline flags

If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.

Root Command

Serve ownCloud Web for oCIS

Usage: web [global options] command [command options] [arguments...]

-log-level | $WEB_LOG_LEVEL
Set logging level. Default: info.
-log-pretty | $WEB_LOG_PRETTY
Enable pretty logging. Default: true.
-log-color | $WEB_LOG_COLOR
Enable colored logging. Default: true.

Sub Commands

web server

Start integrated server

Usage: web server [command options] [arguments...]

-config-file | $WEB_CONFIG_FILE
Path to config file.
-tracing-enabled | $WEB_TRACING_ENABLED
Enable sending traces.
-tracing-type | $WEB_TRACING_TYPE
Tracing backend type. Default: jaeger.
-tracing-endpoint | $WEB_TRACING_ENDPOINT
Endpoint for the agent.
-tracing-collector | $WEB_TRACING_COLLECTOR
Endpoint for the collector.
-tracing-service | $WEB_TRACING_SERVICE
Service name for tracing. Default: web.
-debug-addr | $WEB_DEBUG_ADDR
Address to bind debug server. Default: 0.0.0.0:9104.
-debug-token | $WEB_DEBUG_TOKEN
Token to grant metrics access.
-debug-pprof | $WEB_DEBUG_PPROF
Enable pprof debugging.
-debug-zpages | $WEB_DEBUG_ZPAGES
Enable zpages debugging.
-http-addr | $WEB_HTTP_ADDR
Address to bind http server. Default: 0.0.0.0:9100.
-http-root | $WEB_HTTP_ROOT
Root path of http server. Default: /.
-http-namespace | $WEB_NAMESPACE
Set the base namespace for the http namespace. Default: com.owncloud.web.
-asset-path | $WEB_ASSET_PATH
Path to custom assets.
-web-config | $WEB_UI_CONFIG
Path to web config.
-web-config-server | $WEB_UI_CONFIG_SERVER , $OCIS_URL
Server URL. Default: https://localhost:9200.
-web-config-theme | $WEB_UI_CONFIG_THEME
Theme. Default: owncloud.
-web-config-version | $WEB_UI_CONFIG_VERSION
Version. Default: 0.1.0.
-oidc-metadata-url | $WEB_OIDC_METADATA_URL
OpenID Connect metadata URL, defaults to <WEB_OIDC_AUTHORITY>/.well-known/openid-configuration.
-oidc-authority | $WEB_OIDC_AUTHORITY , $OCIS_URL
OpenID Connect authority. Default: https://localhost:9200.
-oidc-client-id | $WEB_OIDC_CLIENT_ID
OpenID Connect client ID. Default: web.
-oidc-response-type | $WEB_OIDC_RESPONSE_TYPE
OpenID Connect response type. Default: code.
-oidc-scope | $WEB_OIDC_SCOPE
OpenID Connect scope. Default: openid profile email.

web health

Check health status

Usage: web health [command options] [arguments...]

-debug-addr | $WEB_DEBUG_ADDR
Address to debug endpoint. Default: 0.0.0.0:9104.