sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use new package structuring, embed existing extensions

Browse Source
This commit is contained in:
Thomas Boerger
2019-12-10 15:24:01 +01:00
parent 6b6b1d8b66
commit 1612e4a841
30 changed files with 2045 additions and 278 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/getting-started.md
+17 -15
View File
@@ -7,7 +7,7 @@ weight: 20
## Installation
So far we are offering two different variants for the installation. You can choose between [Docker](docker) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
### Docker
@@ -39,7 +39,7 @@ OCIS_LOG_PRETTY
#### Server
OCIS_DEBUG_ADDR
: Address to bind debug server, defaults to `0.0.0.0:8001`
: Address to bind debug server, defaults to `0.0.0.0:9010`
OCIS_DEBUG_TOKEN
: Token to grant metrics access, empty default value
@@ -48,18 +48,21 @@ OCIS_DEBUG_PPROF
: Enable pprof debugging, defaults to `false`
OCIS_HTTP_ADDR
: Address to bind http server, defaults to `0.0.0.0:8000`
: Address to bind http server, defaults to `0.0.0.0:9000`
OCIS_HTTP_ROOT
: Root path for http endpoint, defaults to `/`
OCIS_GRPC_ADDR
: Address to bind grpc server, defaults to `0.0.0.0:9001`
OCIS_SERVICES_ENABLED
: List of enabled services, defaults to `phoenix,ocs,webdav,hello`
: List of enabled services, defaults to `phoenix,konnectd,graph,ocs,webdav,hello`
#### Health
OCIS_DEBUG_ADDR
: Address to debug endpoint, defaults to `0.0.0.0:8001`
: Address to debug endpoint, defaults to `0.0.0.0:9010`
### Commandline flags
@@ -79,7 +82,7 @@ If you prefer to configure the service with commandline flags you can see the av
#### Server
--debug-addr
: Address to bind debug server, defaults to `0.0.0.0:8001`
: Address to bind debug server, defaults to `0.0.0.0:9010`
--debug-token
: Token to grant metrics access, empty default value
@@ -88,22 +91,25 @@ If you prefer to configure the service with commandline flags you can see the av
: Enable pprof debugging, defaults to `false`
--http-addr
: Address to bind http server, defaults to `0.0.0.0:8000`
: Address to bind http server, defaults to `0.0.0.0:9000`
--http-root
: Root path for http endpoint, defaults to `/`
--grpc-addr
: Address to bind grpc server, defaults to `0.0.0.0:9001`
--services-enabled
: List of enabled services, defaults to `phoenix,ocs,webdav,hello`
: List of enabled services, defaults to `phoenix,konnectd,graph,ocs,webdav,hello`
#### Health
--debug-addr
: Address to debug endpoint, defaults to `0.0.0.0:8001`
: Address to debug endpoint, defaults to `0.0.0.0:9010`
### Configuration file
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](repo), 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`.
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`.
## Usage
@@ -127,7 +133,7 @@ ocis health --help
## Metrics
This service provides some [Prometheus](prom) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `OCIS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:8001/metrics`.
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `OCIS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:8001/metrics`.
go_gc_duration_seconds
: A summary of the GC invocation durations
@@ -224,7 +230,3 @@ promhttp_metric_handler_requests_in_flight
promhttp_metric_handler_requests_total
: Total number of scrapes by HTTP status code
[docker]: https://www.docker.com/
[repo]: https://github.com/owncloud/ocis/tree/master/config
[prom]: https://prometheus.io/