Configuration using config files

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


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

accounts health

Check health status

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

Address to debug endpoint. Default:

accounts wopiserver

wopiserver, an example oCIS extension

Usage: accounts wopiserver [command options] [arguments...]

Path to config file.
Set logging level. Default: info.
Enable pretty logging.
Enable colored logging.

accounts server

start wopiserver

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

Enable log to file.
Enable sending traces.
Tracing backend type. Default: jaeger.
Endpoint for the agent.
Endpoint for the collector.
Service name for tracing. Default: wopiserver.
Address to bind debug server. Default:
Token to grant metrics access.
Enable pprof debugging.
Enable zpages debugging.
Set the base namespace for the http namespace. Default: com.owncloud.web.
Address to bind http server. Default:
Root path of http server. Default: /.
Set the base namespace for the grpc namespace. Default: com.owncloud.api.
service name. Default: flags.OverrideDefaultString(cfg.Server.Name, "wopiserver").
Address to bind grpc server. Default:
Path to custom assets.
-wopi-server-secret | $WOPISERVER_WOPI_SERVER_SECRET
Used to create JWT tokens for the WOPI server. Default: Pive-Fumkiu4.
-wopi-server-host | $WOPISERVER_WOPI_SERVER_HOST
Wopiserver Host. Default:
-wopi-server-insecure | $WOPISERVER_WOPI_SERVER_INSECURE
Wopiserver insecure. Default: false.
Used to create JWT to talk to reva, should equal reva’s jwt-secret. Default: flags.OverrideDefaultString(cfg.TokenManager.JWTSecret, "Pive-Fumkiu4").
-reva-gateway-addr | $WOPISERVER_REVA_GATEWAY_ADDR
Reva gateway address. Default: flags.OverrideDefaultString(cfg.WopiServer.RevaGateway, "").