---
title: "Configuration"
date: "2020-08-21T17:50:21+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs
geekdocFilePath: configuration.md
---

{{< toc >}}

## 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. https://owncloud.github.io/extensions/ocis_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.

### Configuration using config files

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

```console
/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](https://github.com/owncloud/ocis/tree/master/config), 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`.

### Envrionment variables

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

### 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

ownCloud Infinite Scale Stack

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

--config-file | $OCIS_CONFIG_FILE  
: Path to config file.

--log-level | $OCIS_LOG_LEVEL  
: Set logging level. Default: `info`.

--log-pretty | $OCIS_LOG_PRETTY  
: Enable pretty logging. Default: `true`.

--log-color | $OCIS_LOG_COLOR  
: Enable colored logging. Default: `true`.

## Sub Commands

### ocis server

Start fullstack server

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

--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. Default: `localhost:6831`.

--tracing-collector | $OCIS_TRACING_COLLECTOR  
: Endpoint for the collector. Default: `http://localhost:14268/api/traces`.

--tracing-service | $OCIS_TRACING_SERVICE  
: Service name for tracing. Default: `ocis`.

--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`.

### ocis health

Check health status

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

--debug-addr | $OCIS_DEBUG_ADDR  
: Address to debug endpoint. Default: `0.0.0.0:9010`.

### List of available Extension subcommands

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.

#### ocis glauth

Start glauth server

#### ocis ocs

Start ocs server

#### ocis store

Start a go-micro store

#### ocis reva-auth-basic

Start reva auth-basic service

#### ocis reva-storage-oc

Start reva oc storage

#### ocis run

Runs an extension

#### ocis graph-explorer

Start graph explorer

#### ocis hello

Start hello server

#### ocis phoenix

Start phoenix server

#### ocis reva-storage-eos-data

Start reva eos storage dataprovider

#### ocis reva-frontend

Start reva frontend

#### ocis reva-storage-home

Start reva home storage

#### ocis webdav

Start webdav server

#### ocis konnectd

Start konnectd server

#### ocis reva-auth-bearer

Start reva auth-bearer service

#### ocis reva-storage-home-data

Start reva home storage dataprovider

#### ocis reva-users

Start reva users service

#### ocis accounts

Start accounts server

#### ocis graph

Start graph server

#### ocis reva-storage-oc-data

Start reva oc storage dataprovider

#### ocis proxy

Start proxy server

#### ocis reva-storage-eos

Start reva eos storage

#### ocis settings

Start settings server

#### ocis kill

Kill an extension by name

#### ocis list

Lists running ocis extensions

#### ocis import

Import a user exported by owncloud/data_exporter

#### ocis thumbnails

Start thumbnails server

#### ocis reva-gateway

Start reva gateway

#### ocis reva-sharing

Start reva sharing service

#### ocis reva-storage-public-link

Start reva public link storage

#### ocis reva-storage-root

Start reva root storage