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

run remark linter locally

Browse Source
This commit is contained in:
A.Unger
2020-09-23 11:34:32 +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
konnectd/CHANGELOG.md
+60 -61
View File
@@ -1,4 +1,4 @@
# Changelog for [0.3.2] (2020-07-23)
# Changelog for [0.3.2] \(2020-07-23)
The following sections list the changes in ocis-konnectd 0.3.2.
@@ -6,27 +6,27 @@ The following sections list the changes in ocis-konnectd 0.3.2.
## Summary
* Bugfix - Add silent redirect url: [#69](https://github.com/owncloud/ocis/konnectd/issues/69)
* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#71](https://github.com/owncloud/ocis/konnectd/pull/71)
- Bugfix - Add silent redirect url: [#69](https://github.com/owncloud/ocis/konnectd/issues/69)
- Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#71](https://github.com/owncloud/ocis/konnectd/pull/71)
## Details
* Bugfix - Add silent redirect url: [#69](https://github.com/owncloud/ocis/konnectd/issues/69)
- Bugfix - Add silent redirect url: [#69](https://github.com/owncloud/ocis/konnectd/issues/69)
Adds the oidc-silent-redirect.html phoenix uses to silently refresh access tokens to the
default identifier-registration.yml
Adds the oidc-silent-redirect.html phoenix uses to silently refresh access tokens to the
default identifier-registration.yml
https://github.com/owncloud/ocis/konnectd/issues/69
https://github.com/owncloud/ocis/konnectd/pull/70
<https://github.com/owncloud/ocis/konnectd/issues/69>
<https://github.com/owncloud/ocis/konnectd/pull/70>
* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#71](https://github.com/owncloud/ocis/konnectd/pull/71)
- Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#71](https://github.com/owncloud/ocis/konnectd/pull/71)
ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
https://github.com/owncloud/ocis/konnectd/pull/71
<https://github.com/owncloud/ocis/konnectd/pull/71>
# Changelog for [0.3.1] (2020-04-14)
# Changelog for [0.3.1] \(2020-04-14)
The following sections list the changes in ocis-konnectd 0.3.1.
@@ -34,17 +34,17 @@ The following sections list the changes in ocis-konnectd 0.3.1.
## Summary
* Bugfix - Include the assets for #62: [#64](https://github.com/owncloud/ocis/konnectd/pull/64)
- Bugfix - Include the assets for #62: [#64](https://github.com/owncloud/ocis/konnectd/pull/64)
## Details
* Bugfix - Include the assets for #62: [#64](https://github.com/owncloud/ocis/konnectd/pull/64)
- Bugfix - Include the assets for #62: [#64](https://github.com/owncloud/ocis/konnectd/pull/64)
PR 62 introduced new client names. These assets needs to be generated in the embed.go file.
PR 62 introduced new client names. These assets needs to be generated in the embed.go file.
https://github.com/owncloud/ocis/konnectd/pull/64
<https://github.com/owncloud/ocis/konnectd/pull/64>
# Changelog for [0.3.0] (2020-04-14)
# Changelog for [0.3.0] \(2020-04-14)
The following sections list the changes in ocis-konnectd 0.3.0.
@@ -52,41 +52,41 @@ The following sections list the changes in ocis-konnectd 0.3.0.
## Summary
* Bugfix - Redirect to the provided uri: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
* Change - Add a trailing slash to trusted redirect uris: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
* Change - Improve client identifiers for end users: [#62](https://github.com/owncloud/ocis/konnectd/pull/62)
* Enhancement - Use upstream version of konnect library: [#14](https://github.com/owncloud/product/issues/14)
- Bugfix - Redirect to the provided uri: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
- Change - Add a trailing slash to trusted redirect uris: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
- Change - Improve client identifiers for end users: [#62](https://github.com/owncloud/ocis/konnectd/pull/62)
- Enhancement - Use upstream version of konnect library: [#14](https://github.com/owncloud/product/issues/14)
## Details
* Bugfix - Redirect to the provided uri: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
- Bugfix - Redirect to the provided uri: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
The phoenix client was not set as trusted therefore when logging out the user was redirected to a
default page instead of the provided url.
The phoenix client was not set as trusted therefore when logging out the user was redirected to a
default page instead of the provided url.
https://github.com/owncloud/ocis/konnectd/issues/26
<https://github.com/owncloud/ocis/konnectd/issues/26>
* Change - Add a trailing slash to trusted redirect uris: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
- Change - Add a trailing slash to trusted redirect uris: [#26](https://github.com/owncloud/ocis/konnectd/issues/26)
Phoenix changed the redirect uri to `<baseUrl>#/login` that means it will contain a trailing
slash after the base url.
Phoenix changed the redirect uri to `<baseUrl>#/login` that means it will contain a trailing
slash after the base url.
https://github.com/owncloud/ocis/konnectd/issues/26
<https://github.com/owncloud/ocis/konnectd/issues/26>
* Change - Improve client identifiers for end users: [#62](https://github.com/owncloud/ocis/konnectd/pull/62)
- Change - Improve client identifiers for end users: [#62](https://github.com/owncloud/ocis/konnectd/pull/62)
Improved end user facing client names in default identifier-registration.yaml
Improved end user facing client names in default identifier-registration.yaml
https://github.com/owncloud/ocis/konnectd/pull/62
<https://github.com/owncloud/ocis/konnectd/pull/62>
* Enhancement - Use upstream version of konnect library: [#14](https://github.com/owncloud/product/issues/14)
- Enhancement - Use upstream version of konnect library: [#14](https://github.com/owncloud/product/issues/14)
https://github.com/owncloud/product/issues/14
<https://github.com/owncloud/product/issues/14>
# Changelog for [0.2.0] (2020-03-18)
# Changelog for [0.2.0] \(2020-03-18)
The following sections list the changes in ocis-konnectd 0.2.0.
@@ -94,15 +94,15 @@ The following sections list the changes in ocis-konnectd 0.2.0.
## Summary
* Enhancement - Change default config for single-binary: [#55](https://github.com/owncloud/ocis/konnectd/pull/55)
- Enhancement - Change default config for single-binary: [#55](https://github.com/owncloud/ocis/konnectd/pull/55)
## Details
* Enhancement - Change default config for single-binary: [#55](https://github.com/owncloud/ocis/konnectd/pull/55)
- Enhancement - Change default config for single-binary: [#55](https://github.com/owncloud/ocis/konnectd/pull/55)
https://github.com/owncloud/ocis/konnectd/pull/55
<https://github.com/owncloud/ocis/konnectd/pull/55>
# Changelog for [0.1.0] (2020-03-18)
# Changelog for [0.1.0] \(2020-03-18)
The following sections list the changes in ocis-konnectd 0.1.0.
@@ -110,42 +110,41 @@ The following sections list the changes in ocis-konnectd 0.1.0.
## Summary
* Bugfix - Generate a random CSP-Nonce in the webapp: [#17](https://github.com/owncloud/ocis/konnectd/issues/17)
* Change - Dummy index.html is not required anymore by upstream: [#25](https://github.com/owncloud/ocis/konnectd/issues/25)
* Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/konnectd/issues/1)
* Change - Use glauth as ldap backend, default to running behind ocis-proxy: [#52](https://github.com/owncloud/ocis/konnectd/pull/52)
- Bugfix - Generate a random CSP-Nonce in the webapp: [#17](https://github.com/owncloud/ocis/konnectd/issues/17)
- Change - Dummy index.html is not required anymore by upstream: [#25](https://github.com/owncloud/ocis/konnectd/issues/25)
- Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/konnectd/issues/1)
- Change - Use glauth as ldap backend, default to running behind ocis-proxy: [#52](https://github.com/owncloud/ocis/konnectd/pull/52)
## Details
* Bugfix - Generate a random CSP-Nonce in the webapp: [#17](https://github.com/owncloud/ocis/konnectd/issues/17)
- Bugfix - Generate a random CSP-Nonce in the webapp: [#17](https://github.com/owncloud/ocis/konnectd/issues/17)
https://github.com/owncloud/ocis/konnectd/issues/17
https://github.com/owncloud/ocis/konnectd/pull/29
<https://github.com/owncloud/ocis/konnectd/issues/17>
<https://github.com/owncloud/ocis/konnectd/pull/29>
* Change - Dummy index.html is not required anymore by upstream: [#25](https://github.com/owncloud/ocis/konnectd/issues/25)
- Change - Dummy index.html is not required anymore by upstream: [#25](https://github.com/owncloud/ocis/konnectd/issues/25)
The workaround was required as identifier webapp was mandatory, but we serve it from memory.
This also introduces --disable-identifier-webapp flag.
The workaround was required as identifier webapp was mandatory, but we serve it from memory.
This also introduces --disable-identifier-webapp flag.
https://github.com/owncloud/ocis/konnectd/issues/25
<https://github.com/owncloud/ocis/konnectd/issues/25>
* Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/konnectd/issues/1)
- Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/konnectd/issues/1)
Just prepare an initial basic version to serve konnectd embedded into our microservice
infrastructure in the scope of the ownCloud Infinite Scale project.
Just prepare an initial basic version to serve konnectd embedded into our microservice
infrastructure in the scope of the ownCloud Infinite Scale project.
https://github.com/owncloud/ocis/konnectd/issues/1
<https://github.com/owncloud/ocis/konnectd/issues/1>
* Change - Use glauth as ldap backend, default to running behind ocis-proxy: [#52](https://github.com/owncloud/ocis/konnectd/pull/52)
- Change - Use glauth as ldap backend, default to running behind ocis-proxy: [#52](https://github.com/owncloud/ocis/konnectd/pull/52)
We changed the default configuration to integrate better with ocis.
We changed the default configuration to integrate better with ocis.
The default ldap port changes to 9125, which is used by ocis-glauth and we use ocis-proxy to do
the tls offloading. Clients are supposed to use the ocis-proxy endpoint
`https://localhost:9200`
https://github.com/owncloud/ocis/konnectd/pull/52
The default ldap port changes to 9125, which is used by ocis-glauth and we use ocis-proxy to do
the tls offloading. Clients are supposed to use the ocis-proxy endpoint
`https://localhost:9200`
<https://github.com/owncloud/ocis/konnectd/pull/52>
konnectd/README.md
+2 -2
View File
@@ -2,7 +2,7 @@
[![Build Status](https://cloud.drone.io/api/badges/owncloud/ocis-konnectd/status.svg)](https://cloud.drone.io/owncloud/ocis-konnectd)
[![Gitter chat](https://badges.gitter.im/cs3org/reva.svg)](https://gitter.im/cs3org/reva)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f6f9033737404c9da3ba4738b6501bdb)](https://www.codacy.com/manual/owncloud/ocis-konnectd?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=owncloud/ocis-konnectd&amp;utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f6f9033737404c9da3ba4738b6501bdb)](https://www.codacy.com/manual/owncloud/ocis-konnectd?utm_source=github.com&utm_medium=referral&utm_content=owncloud/ocis-konnectd&utm_campaign=Badge_Grade)
[![Go Doc](https://godoc.org/github.com/owncloud/ocis-konnectd?status.svg)](http://godoc.org/github.com/owncloud/ocis-konnectd)
[![Go Report](http://goreportcard.com/badge/github.com/owncloud/ocis-konnectd)](http://goreportcard.com/report/github.com/owncloud/ocis-konnectd)
[![](https://images.microbadger.com/badges/image/owncloud/ocis-konnectd.svg)](http://microbadger.com/images/owncloud/ocis-konnectd "Get your own image badge on microbadger.com")
@@ -28,7 +28,7 @@ make generate build
## Security
If you find a security issue please contact security@owncloud.com first.
If you find a security issue please contact [security@owncloud.com](mailto:security@owncloud.com) first.
## Contributing
konnectd/changelog/0.1.0_2020-03-18/disable-identifier.md
+1 -1
View File
@@ -3,4 +3,4 @@ Change: Dummy index.html is not required anymore by upstream
The workaround was required as identifier webapp was mandatory, but
we serve it from memory. This also introduces --disable-identifier-webapp flag.
https://github.com/owncloud/ocis/konnectd/issues/25
<https://github.com/owncloud/ocis/konnectd/issues/25>
konnectd/changelog/0.1.0_2020-03-18/initial-release.md
+1 -1
View File
@@ -4,4 +4,4 @@ Just prepare an initial basic version to serve konnectd embedded into our
microservice infrastructure in the scope of the ownCloud Infinite Scale
project.
https://github.com/owncloud/ocis/konnectd/issues/1
<https://github.com/owncloud/ocis/konnectd/issues/1>
konnectd/changelog/0.1.0_2020-03-18/new-ocis-config.md
+1 -1
View File
@@ -5,4 +5,4 @@ We changed the default configuration to integrate better with ocis.
The default ldap port changes to 9125, which is used by ocis-glauth and we use ocis-proxy to do the tls offloading.
Clients are supposed to use the ocis-proxy endpoint `https://localhost:9200`
https://github.com/owncloud/ocis/konnectd/pull/52
<https://github.com/owncloud/ocis/konnectd/pull/52>
konnectd/changelog/0.1.0_2020-03-18/set-csp-nonce.md
+2 -2
View File
@@ -1,4 +1,4 @@
Bugfix: Generate a random CSP-Nonce in the webapp
https://github.com/owncloud/ocis/konnectd/issues/17
https://github.com/owncloud/ocis/konnectd/pull/29
<https://github.com/owncloud/ocis/konnectd/issues/17>
<https://github.com/owncloud/ocis/konnectd/pull/29>
konnectd/changelog/0.2.0_2020-03-18/change-internal-defaults.md
+1 -1
View File
@@ -1,3 +1,3 @@
Enhancement: Change default config for single-binary
https://github.com/owncloud/ocis/konnectd/pull/55
<https://github.com/owncloud/ocis/konnectd/pull/55>
konnectd/changelog/0.3.0_2020-04-14/change_redirect_uri.md
+1 -1
View File
@@ -2,4 +2,4 @@ Change: add a trailing slash to trusted redirect uris
Phoenix changed the redirect uri to `<baseUrl>#/login` that means it will contain a trailing slash after the base url.
https://github.com/owncloud/ocis/konnectd/issues/26
<https://github.com/owncloud/ocis/konnectd/issues/26>
konnectd/changelog/0.3.0_2020-04-14/client_names.md
+1 -1
View File
@@ -2,4 +2,4 @@ Change: improve client identifiers for end users
Improved end user facing client names in default identifier-registration.yaml
https://github.com/owncloud/ocis/konnectd/pull/62
<https://github.com/owncloud/ocis/konnectd/pull/62>
konnectd/changelog/0.3.0_2020-04-14/logout_redirect.md
+1 -1
View File
@@ -2,4 +2,4 @@ Bugfix: redirect to the provided uri
The phoenix client was not set as trusted therefore when logging out the user was redirected to a default page instead of the provided url.
https://github.com/owncloud/ocis/konnectd/issues/26
<https://github.com/owncloud/ocis/konnectd/issues/26>
konnectd/changelog/0.3.0_2020-04-14/use-konnect-upstream.md
+1 -2
View File
@@ -1,4 +1,3 @@
Enhancement: Use upstream version of konnect library
https://github.com/owncloud/product/issues/14
<https://github.com/owncloud/product/issues/14>
konnectd/changelog/0.3.2_2020-07-23/use-alpine-latest.md
+1 -1
View File
@@ -2,4 +2,4 @@ Bugfix: build docker images with alpine:latest instead of alpine:edge
ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
https://github.com/owncloud/ocis/konnectd/pull/71
<https://github.com/owncloud/ocis/konnectd/pull/71>
konnectd/docs/_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.
konnectd/docs/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.
konnectd/docs/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`.
konnectd/docs/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