mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-02-20 04:29:24 -06:00
Code Issues Packages Projects Releases Wiki Activity

Revert "run remark linter locally"

Browse Source 
This reverts commit 97c348f1ae.
This commit is contained in:
A.Unger
2020-09-23 11:48:59 +02:00
parent 97c348f1ae
commit 8b9e02ec0b
447 changed files with 6088 additions and 6178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/ocis/configuration.md
View File

@@ -1,20 +1,19 @@
* * *
---
title: "Configuration"
date: "2020-09-21T13:14:56+0200"
weight: 20
geekdocRepo: <https://github.com/owncloud/ocis>
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs
geekdocFilePath: configuration.md
---
## geekdocFilePath: configuration.md
{{&lt; toc >}}
{{< 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.
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
@@ -26,7 +25,7 @@ $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 ...`_.
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`.
@@ -44,16 +43,16 @@ ownCloud Infinite Scale Stack
Usage: `ocis [global options] command [command options] [arguments...]`
\--config-file | $OCIS_CONFIG_FILE
--config-file | $OCIS_CONFIG_FILE
: Path to config file.
\--log-level | $OCIS_LOG_LEVEL
--log-level | $OCIS_LOG_LEVEL
: Set logging level. Default: `info`.
\--log-pretty | $OCIS_LOG_PRETTY
--log-pretty | $OCIS_LOG_PRETTY
: Enable pretty logging. Default: `true`.
\--log-color | $OCIS_LOG_COLOR
--log-color | $OCIS_LOG_COLOR
: Enable colored logging. Default: `true`.
## Sub Commands
@@ -64,7 +63,7 @@ Check health status
Usage: `ocis health [command options] [arguments...]`
\--debug-addr | $OCIS_DEBUG_ADDR
--debug-addr | $OCIS_DEBUG_ADDR
: Address to debug endpoint. Default: `0.0.0.0:9010`.
### ocis server
@@ -73,40 +72,40 @@ Start fullstack server
Usage: `ocis server [command options] [arguments...]`
\--tracing-enabled | $OCIS_TRACING_ENABLED
--tracing-enabled | $OCIS_TRACING_ENABLED
: Enable sending traces.
\--tracing-type | $OCIS_TRACING_TYPE
--tracing-type | $OCIS_TRACING_TYPE
: Tracing backend type. Default: `jaeger`.
\--tracing-endpoint | $OCIS_TRACING_ENDPOINT
--tracing-endpoint | $OCIS_TRACING_ENDPOINT
: Endpoint for the agent. Default: `localhost:6831`.
\--tracing-collector | $OCIS_TRACING_COLLECTOR
--tracing-collector | $OCIS_TRACING_COLLECTOR
: Endpoint for the collector. Default: `http://localhost:14268/api/traces`.
\--tracing-service | $OCIS_TRACING_SERVICE
--tracing-service | $OCIS_TRACING_SERVICE
: Service name for tracing. Default: `ocis`.
\--debug-addr | $OCIS_DEBUG_ADDR
--debug-addr | $OCIS_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9010`.
\--debug-token | $OCIS_DEBUG_TOKEN
--debug-token | $OCIS_DEBUG_TOKEN
: Token to grant metrics access.
\--debug-pprof | $OCIS_DEBUG_PPROF
--debug-pprof | $OCIS_DEBUG_PPROF
: Enable pprof debugging.
\--debug-zpages | $OCIS_DEBUG_ZPAGES
--debug-zpages | $OCIS_DEBUG_ZPAGES
: Enable zpages debugging.
\--http-addr | $OCIS_HTTP_ADDR
--http-addr | $OCIS_HTTP_ADDR
: Address to bind http server. Default: `0.0.0.0:9000`.
\--http-root | $OCIS_HTTP_ROOT
--http-root | $OCIS_HTTP_ROOT
: Root path of http server. Default: `/`.
\--grpc-addr | $OCIS_GRPC_ADDR
--grpc-addr | $OCIS_GRPC_ADDR
: Address to bind grpc server. Default: `0.0.0.0:9001`.
### List of available Extension subcommands
@@ -220,3 +219,4 @@ Start thumbnails server
#### ocis webdav
Start webdav server