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

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.

graph server

Start integrated server

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

-log-file | $GRAPH_LOG_FILE , $OCIS_LOG_FILE
Enable log to file.
-tracing-enabled | $GRAPH_TRACING_ENABLED
Enable sending traces.
-tracing-type | $GRAPH_TRACING_TYPE
Tracing backend type. Default: flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger").
-tracing-endpoint | $GRAPH_TRACING_ENDPOINT
Endpoint for the agent. Default: flags.OverrideDefaultString(cfg.Tracing.Endpoint, "").
-tracing-collector | $GRAPH_TRACING_COLLECTOR
Endpoint for the collector. Default: flags.OverrideDefaultString(cfg.Tracing.Collector, "").
-tracing-service | $GRAPH_TRACING_SERVICE
Service name for tracing. Default: flags.OverrideDefaultString(cfg.Tracing.Service, "graph").
-debug-addr | $GRAPH_DEBUG_ADDR
Address to bind debug server. Default: flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124").
-debug-token | $GRAPH_DEBUG_TOKEN
Token to grant metrics access. Default: flags.OverrideDefaultString(cfg.Debug.Token, "").
-debug-pprof | $GRAPH_DEBUG_PPROF
Enable pprof debugging.
-debug-zpages | $GRAPH_DEBUG_ZPAGES
Enable zpages debugging.
-http-addr | $GRAPH_HTTP_ADDR
Address to bind http server. Default: flags.OverrideDefaultString(cfg.HTTP.Addr, "0.0.0.0:9120").
-http-root | $GRAPH_HTTP_ROOT
Root path of http server. Default: flags.OverrideDefaultString(cfg.HTTP.Root, "/graph").
-http-namespace | $GRAPH_HTTP_NAMESPACE
Set the base namespace for the http service for service discovery. Default: flags.OverrideDefaultString(cfg.HTTP.Namespace, "com.owncloud.web").
-ldap-network | $GRAPH_LDAP_NETWORK
Network protocol to use to connect to the Ldap server. Default: flags.OverrideDefaultString(cfg.Ldap.Network, "tcp").
-ldap-address | $GRAPH_LDAP_ADDRESS
Address to connect to the Ldap server. Default: flags.OverrideDefaultString(cfg.Ldap.Address, "0.0.0.0:9125").
-ldap-username | $GRAPH_LDAP_USERNAME
User to bind to the Ldap server. Default: flags.OverrideDefaultString(cfg.Ldap.UserName, "cn=admin,dc=example,dc=org").
-ldap-password | $GRAPH_LDAP_PASSWORD
Password to bind to the Ldap server. Default: flags.OverrideDefaultString(cfg.Ldap.Password, "admin").
-ldap-basedn-users | $GRAPH_LDAP_BASEDN_USERS
BaseDN to look for users. Default: flags.OverrideDefaultString(cfg.Ldap.BaseDNUsers, "ou=users,dc=example,dc=org").
-ldap-basedn-groups | $GRAPH_LDAP_BASEDN_GROUPS
BaseDN to look for users. Default: flags.OverrideDefaultString(cfg.Ldap.BaseDNGroups, "ou=groups,dc=example,dc=org").
-oidc-endpoint | $GRAPH_OIDC_ENDPOINT , $OCIS_URL
OpenIDConnect endpoint. Default: flags.OverrideDefaultString(cfg.OpenIDConnect.Endpoint, "https://localhost:9200").
-oidc-insecure | $GRAPH_OIDC_INSECURE
OpenIDConnect endpoint.
-oidc-realm | $GRAPH_OIDC_REALM
OpenIDConnect realm. Default: flags.OverrideDefaultString(cfg.OpenIDConnect.Realm, "").
-reva-gateway-addr | $REVA_GATEWAY_ADDR
REVA Gateway Endpoint. Default: flags.OverrideDefaultString(cfg.Reva.Address, "127.0.0.1:9142").

graph health

Check health status

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

-debug-addr | $GRAPH_DEBUG_ADDR
Address to debug endpoint. Default: flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124").

graph ocis-graph

Serve Graph API for oCIS

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

-config-file | $GRAPH_CONFIG_FILE
Path to config file. Default: flags.OverrideDefaultString(cfg.File, "").
-log-level | $GRAPH_LOG_LEVEL , $OCIS_LOG_LEVEL
Set logging level.
-log-pretty | $GRAPH_LOG_PRETTY , $OCIS_LOG_PRETTY
Enable pretty logging.
-log-color | $GRAPH_LOG_COLOR , $OCIS_LOG_COLOR
Enable colored logging.