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-ocs reads ocs.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.

ocs health

Check health status

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

-debug-addr | $OCS_DEBUG_ADDR
Address to debug endpoint. Default: 0.0.0.0:9114.

ocs ocis-ocs

Serve OCS API for oCIS

Usage: ocs ocis-ocs [command options] [arguments...]

-log-level | $OCS_LOG_LEVEL
Set logging level. Default: info.
-log-pretty | $OCS_LOG_PRETTY
Enable pretty logging. Default: true.
-log-color | $OCS_LOG_COLOR
Enable colored logging. Default: true.

ocs server

Start integrated server

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

-config-file | $OCS_CONFIG_FILE
Path to config file.
-tracing-enabled | $OCS_TRACING_ENABLED
Enable sending traces. Default: false.
-tracing-type | $OCS_TRACING_TYPE
Tracing backend type. Default: jaeger.
-tracing-endpoint | $OCS_TRACING_ENDPOINT
Endpoint for the agent.
-tracing-collector | $OCS_TRACING_COLLECTOR
Endpoint for the collector.
-tracing-service | $OCS_TRACING_SERVICE
Service name for tracing. Default: ocs.
-debug-addr | $OCS_DEBUG_ADDR
Address to bind debug server. Default: 0.0.0.0:9114.
-debug-token | $OCS_DEBUG_TOKEN
Token to grant metrics access.
-debug-pprof | $OCS_DEBUG_PPROF
Enable pprof debugging.
-debug-zpages | $OCS_DEBUG_ZPAGES
Enable zpages debugging.
-http-addr | $OCS_HTTP_ADDR
Address to bind http server. Default: 0.0.0.0:9110.
-http-namespace | $OCS_NAMESPACE
Set the base namespace for the http namespace. Default: com.owncloud.web.
-name | $OCS_NAME
Service name. Default: ocs.
-http-root | $OCS_HTTP_ROOT
Root path of http server. Default: /ocs.
-jwt-secret | $OCS_JWT_SECRET , $OCIS_JWT_SECRET
Used to dismantle the access token, should equal reva’s jwt-secret. Default: Pive-Fumkiu4.

ocs version

Print the versions of the running instances

Usage: ocs version [command options] [arguments...]

-http-namespace | $OCS_NAMESPACE
Set the base namespace for the http namespace. Default: com.owncloud.web.
-name | $OCS_NAME
Service name. Default: ocs.