Configuration

oCIS Single Binary is not responsible for configuring extensions. Instead, each extension could either be configured by environment variables, cli flags or config files.

Each extension has its dedicated documentation page (e.g. proxy configuration) which lists all possible configurations. Config files and environment variables are picked up if you use the ./bin/ocis server command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.

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

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.

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.

ownCloud Infinite Scale Stack

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

-log-level | $OCIS_LOG_LEVEL

Set logging level. Default: info.

-log-pretty | $OCIS_LOG_PRETTY

Enable pretty logging. Default: false.

-log-color | $OCIS_LOG_COLOR

Enable colored logging. Default: true.

-tracing-enabled | $OCIS_TRACING_ENABLED

Enable sending traces.

-tracing-type | $OCIS_TRACING_TYPE

Tracing backend type. Default: jaeger.

-tracing-endpoint | $OCIS_TRACING_ENDPOINT

Endpoint for the agent.

-tracing-collector | $OCIS_TRACING_COLLECTOR

Endpoint for the collector.

-tracing-service | $OCIS_TRACING_SERVICE

Service name for tracing. Default: ocis.

-jwt-secret | $OCIS_JWT_SECRET

Used to dismantle the access token, should equal reva’s jwt-secret. Default: Pive-Fumkiu4.

Lists running ocis extensions

Usage: ocis list [command options] [arguments...]

Check health status

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

-debug-addr | $OCIS_DEBUG_ADDR

Address to debug endpoint. Default: 0.0.0.0:9010.

Kill an extension by name

Usage: ocis kill [command options] [arguments...]

Start fullstack server

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

-debug-addr | $OCIS_DEBUG_ADDR

Address to bind debug server. Default: 0.0.0.0:9010.

-debug-token | $OCIS_DEBUG_TOKEN

Token to grant metrics access.

-debug-pprof | $OCIS_DEBUG_PPROF

Enable pprof debugging.

-debug-zpages | $OCIS_DEBUG_ZPAGES

Enable zpages debugging.

-http-addr | $OCIS_HTTP_ADDR

Address to bind http server. Default: 0.0.0.0:9000.

-http-root | $OCIS_HTTP_ROOT

Root path of http server. Default: /.

-grpc-addr | $OCIS_GRPC_ADDR

Address to bind grpc server. Default: 0.0.0.0:9001.

Runs an extension

Usage: ocis run [command options] [arguments...]

There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation.

Start settings server

Start storage frontend

Start storage and data provider for /users mount

Start glauth server

Start storage gateway

Start storage and data provider for /home mount

Start accounts server

Start ocs server

Start storage auth-bearer service

Start storage groupprovider service

Start storage and data service for metadata

Start storage userprovider service

Start idp server

Start onlyoffice server

Start web server

Start webdav server

Start storage sharing service

Start a go-micro store

Start proxy server

Start storage auth-basic service

Start storage public link storage

Start thumbnails server

Lists running services with version