mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-04-24 04:58:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

run remark linter locally

Browse Source
This commit is contained in:
A.Unger
2020-09-23 11:34:11 +02:00
parent d9e8b60f49
commit 97c348f1ae
447 changed files with 6178 additions and 6088 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/extensions/konnectd/_index.md
+5 -4
View File
@@ -1,8 +1,9 @@
---
* * *
title: Konnectd
geekdocRepo: https://github.com/owncloud/ocis-konnectd
geekdocRepo: <https://github.com/owncloud/ocis-konnectd>
geekdocEditPath: edit/master/docs
geekdocFilePath: _index.md
---
## geekdocFilePath: \_index.md
This service provides an OpenID Connect provider which is the default way to authenticate in OCIS.
docs/extensions/konnectd/building.md
+11 -10
View File
@@ -1,28 +1,29 @@
---
* * *
title: "Building"
date: 2020-02-21T00:00:00+00:00
weight: 30
geekdocRepo: https://github.com/owncloud/ocis-konnectd
geekdocRepo: <https://github.com/owncloud/ocis-konnectd>
geekdocEditPath: edit/master/docs
geekdocFilePath: building.md
---
{{< toc >}}
## geekdocFilePath: building.md
{{&lt; toc >}}
As this project is built with Go, so you need to install that first. The installation of Go is out of the scope of this document, please follow the official documentation for [Go](https://golang.org/doc/install), to build this project you have to install Go >= v1.13. After the installation of the required tools you need to get the sources:
{{< highlight txt >}}
git clone https://github.com/owncloud/ocis-konnectd.git
{{&lt; highlight txt >}}
git clone <https://github.com/owncloud/ocis-konnectd.git>
cd ocis-konnectd
{{< / highlight >}}
{{&lt; / highlight >}}
All required tool besides Go itself and make are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile`.
## Backend
{{< highlight txt >}}
{{&lt; highlight txt >}}
make generate
make build
{{< / highlight >}}
{{&lt; / highlight >}}
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-konnectd -h` to see all available options and subcommands.
docs/extensions/konnectd/configuration.md
+47 -47
View File
@@ -1,19 +1,20 @@
---
* * *
title: "Configuration"
date: "2020-09-21T13:14:47+0200"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-konnectd
geekdocRepo: <https://github.com/owncloud/ocis-konnectd>
geekdocEditPath: edit/master/docs
geekdocFilePath: configuration.md
---
{{< toc >}}
## geekdocFilePath: configuration.md
{{&lt; 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
@@ -25,7 +26,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`.
@@ -43,16 +44,16 @@ Serve Konnectd API for oCIS
Usage: `ocis-konnectd [global options] command [command options] [arguments...]`
--config-file | $KONNECTD_CONFIG_FILE
\--config-file | $KONNECTD_CONFIG_FILE
: Path to config file.
--log-level | $KONNECTD_LOG_LEVEL
\--log-level | $KONNECTD_LOG_LEVEL
: Set logging level. Default: `info`.
--log-pretty | $KONNECTD_LOG_PRETTY
\--log-pretty | $KONNECTD_LOG_PRETTY
: Enable pretty logging. Default: `true`.
--log-color | $KONNECTD_LOG_COLOR
\--log-color | $KONNECTD_LOG_COLOR
: Enable colored logging. Default: `true`.
## Sub Commands
@@ -63,7 +64,7 @@ Check health status
Usage: `ocis-konnectd health [command options] [arguments...]`
--debug-addr | $KONNECTD_DEBUG_ADDR
\--debug-addr | $KONNECTD_DEBUG_ADDR
: Address to debug endpoint. Default: `0.0.0.0:9134`.
### ocis-konnectd server
@@ -72,105 +73,104 @@ Start integrated server
Usage: `ocis-konnectd server [command options] [arguments...]`
--tracing-enabled | $KONNECTD_TRACING_ENABLED
\--tracing-enabled | $KONNECTD_TRACING_ENABLED
: Enable sending traces.
--tracing-type | $KONNECTD_TRACING_TYPE
\--tracing-type | $KONNECTD_TRACING_TYPE
: Tracing backend type. Default: `jaeger`.
--tracing-endpoint | $KONNECTD_TRACING_ENDPOINT
\--tracing-endpoint | $KONNECTD_TRACING_ENDPOINT
: Endpoint for the agent.
--tracing-collector | $KONNECTD_TRACING_COLLECTOR
\--tracing-collector | $KONNECTD_TRACING_COLLECTOR
: Endpoint for the collector.
--tracing-service | $KONNECTD_TRACING_SERVICE
\--tracing-service | $KONNECTD_TRACING_SERVICE
: Service name for tracing. Default: `konnectd`.
--debug-addr | $KONNECTD_DEBUG_ADDR
\--debug-addr | $KONNECTD_DEBUG_ADDR
: Address to bind debug server. Default: `0.0.0.0:9134`.
--debug-token | $KONNECTD_DEBUG_TOKEN
\--debug-token | $KONNECTD_DEBUG_TOKEN
: Token to grant metrics access.
--debug-pprof | $KONNECTD_DEBUG_PPROF
\--debug-pprof | $KONNECTD_DEBUG_PPROF
: Enable pprof debugging.
--debug-zpages | $KONNECTD_DEBUG_ZPAGES
\--debug-zpages | $KONNECTD_DEBUG_ZPAGES
: Enable zpages debugging.
--http-addr | $KONNECTD_HTTP_ADDR
\--http-addr | $KONNECTD_HTTP_ADDR
: Address to bind http server. Default: `0.0.0.0:9130`.
--http-root | $KONNECTD_HTTP_ROOT
\--http-root | $KONNECTD_HTTP_ROOT
: Root path of http server. Default: `/`.
--http-namespace | $KONNECTD_HTTP_NAMESPACE
\--http-namespace | $KONNECTD_HTTP_NAMESPACE
: Set the base namespace for service discovery. Default: `com.owncloud.web`.
--identity-manager | $KONNECTD_IDENTITY_MANAGER
\--identity-manager | $KONNECTD_IDENTITY_MANAGER
: Identity manager (one of ldap,kc,cookie,dummy). Default: `ldap`.
--transport-tls-cert | $KONNECTD_TRANSPORT_TLS_CERT
\--transport-tls-cert | $KONNECTD_TRANSPORT_TLS_CERT
: Certificate file for transport encryption.
--transport-tls-key | $KONNECTD_TRANSPORT_TLS_KEY
\--transport-tls-key | $KONNECTD_TRANSPORT_TLS_KEY
: Secret file for transport encryption.
--iss | $KONNECTD_ISS
\--iss | $KONNECTD_ISS
: OIDC issuer URL. Default: `https://localhost:9200`.
--signing-kid | $KONNECTD_SIGNING_KID
\--signing-kid | $KONNECTD_SIGNING_KID
: Value of kid field to use in created tokens (uniquely identifying the signing-private-key).
--validation-keys-path | $KONNECTD_VALIDATION_KEYS_PATH
\--validation-keys-path | $KONNECTD_VALIDATION_KEYS_PATH
: Full path to a folder containg PEM encoded private or public key files used for token validaton (file name without extension is used as kid).
--encryption-secret | $KONNECTD_ENCRYPTION_SECRET
\--encryption-secret | $KONNECTD_ENCRYPTION_SECRET
: Full path to a file containing a %d bytes secret key.
--signing-method | $KONNECTD_SIGNING_METHOD
\--signing-method | $KONNECTD_SIGNING_METHOD
: JWT default signing method. Default: `PS256`.
--uri-base-path | $KONNECTD_URI_BASE_PATH
\--uri-base-path | $KONNECTD_URI_BASE_PATH
: Custom base path for URI endpoints.
--sign-in-uri | $KONNECTD_SIGN_IN_URI
\--sign-in-uri | $KONNECTD_SIGN_IN_URI
: Custom redirection URI to sign-in form.
--signed-out-uri | $KONNECTD_SIGN_OUT_URI
\--signed-out-uri | $KONNECTD_SIGN_OUT_URI
: Custom redirection URI to signed-out goodbye page.
--authorization-endpoint-uri | $KONNECTD_ENDPOINT_URI
\--authorization-endpoint-uri | $KONNECTD_ENDPOINT_URI
: Custom authorization endpoint URI.
--endsession-endpoint-uri | $KONNECTD_ENDSESSION_ENDPOINT_URI
\--endsession-endpoint-uri | $KONNECTD_ENDSESSION_ENDPOINT_URI
: Custom endsession endpoint URI.
--asset-path | $KONNECTD_ASSET_PATH
\--asset-path | $KONNECTD_ASSET_PATH
: Path to custom assets.
--identifier-client-path | $KONNECTD_IDENTIFIER_CLIENT_PATH
\--identifier-client-path | $KONNECTD_IDENTIFIER_CLIENT_PATH
: Path to the identifier web client base folder. Default: `/var/tmp/konnectd`.
--identifier-registration-conf | $KONNECTD_IDENTIFIER_REGISTRATION_CONF
\--identifier-registration-conf | $KONNECTD_IDENTIFIER_REGISTRATION_CONF
: Path to a identifier-registration.yaml configuration file. Default: `./config/identifier-registration.yaml`.
--identifier-scopes-conf | $KONNECTD_IDENTIFIER_SCOPES_CONF
\--identifier-scopes-conf | $KONNECTD_IDENTIFIER_SCOPES_CONF
: Path to a scopes.yaml configuration file.
--insecure | $KONNECTD_INSECURE
\--insecure | $KONNECTD_INSECURE
: Disable TLS certificate and hostname validation.
--tls | $KONNECTD_TLS
\--tls | $KONNECTD_TLS
: Use TLS (disable only if konnectd is behind a TLS-terminating reverse-proxy).. Default: `false`.
--allow-client-guests | $KONNECTD_ALLOW_CLIENT_GUESTS
\--allow-client-guests | $KONNECTD_ALLOW_CLIENT_GUESTS
: Allow sign in of client controlled guest users.
--allow-dynamic-client-registration | $KONNECTD_ALLOW_DYNAMIC_CLIENT_REGISTRATION
\--allow-dynamic-client-registration | $KONNECTD_ALLOW_DYNAMIC_CLIENT_REGISTRATION
: Allow dynamic OAuth2 client registration.
--disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP
\--disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP
: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`.
docs/extensions/konnectd/getting-started.md
+12 -11
View File
@@ -1,13 +1,14 @@
---
* * *
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
weight: 10
geekdocRepo: https://github.com/owncloud/ocis-konnectd
geekdocRepo: <https://github.com/owncloud/ocis-konnectd>
geekdocEditPath: edit/master/docs
geekdocFilePath: getting-started.md
---
{{< toc >}}
## geekdocFilePath: getting-started.md
{{&lt; toc >}}
## Installation
@@ -15,7 +16,7 @@ So far we are offering two different variants for the installation. You can choo
### Docker
Docker images for ocis-reva are hosted on https://hub.docker.com/r/owncloud/ocis-konnectd.
Docker images for ocis-reva are hosted on <https://hub.docker.com/r/owncloud/ocis-konnectd>.
The `latest` tag always reflects the current master branch.
@@ -25,7 +26,7 @@ docker pull owncloud/ocis-konnectd
### Binaries
The pre-built binaries for different platforms are downloadable at https://download.owncloud.com/ocis/ocis-konnectd/ . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in https://download.owncloud.com/ocis/ocis-konnectd/testing/
The pre-built binaries for different platforms are downloadable at <https://download.owncloud.com/ocis/ocis-konnectd/> . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in <https://download.owncloud.com/ocis/ocis-konnectd/testing/>
```console
curl https://download.owncloud.com/ocis/ocis-konnectd/1.0.0-beta1/ocis-konnectd-1.0.0-beta1-darwin-amd64 --output ocis-konnectd
@@ -41,17 +42,17 @@ The program provides a few sub-commands on execution. The available configuratio
The server command is used to start the http and debug server on two addresses within a single process. The http server is serving the general webservice while the debug server is used for health check, readiness check and to server the metrics mentioned below. For further help please execute:
{{< highlight txt >}}
{{&lt; highlight txt >}}
ocis-konnectd server --help
{{< / highlight >}}
{{&lt; / highlight >}}
### Health
The health command is used to execute a health check, if the exit code equals zero the service should be up and running, if the exist code is greater than zero the service is not in a healthy state. Generally this command is used within our Docker containers, it could also be used within Kubernetes.
{{< highlight txt >}}
{{&lt; highlight txt >}}
ocis-konnectd health --help
{{< / highlight >}}
{{&lt; / highlight >}}
## Metrics