Revert "run remark linter locally"

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

View File

@@ -1,15 +1,14 @@
* * *
---
title: "GLAuth"
date: 2018-05-02T00:00:00+00:00
weight: 10
geekdocRepo: <https://github.com/owncloud/ocis-glauth>
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
## geekdocFilePath: \_index.md
geekdocFilePath: _index.md
---
This service provides a simple glauth world API which can be used by clients or other extensions.
- reiner proxy
ldap für eos und firewall
- backend ist der accounts service
- reiner proxy
ldap für eos und firewall
- backend ist der accounts service

View File

@@ -1,29 +1,28 @@
* * *
---
title: "Building"
date: 2018-05-02T00:00:00+00:00
weight: 30
geekdocRepo: <https://github.com/owncloud/ocis-glauth>
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
geekdocFilePath: building.md
---
## geekdocFilePath: building.md
{{&lt; toc >}}
{{< 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:
{{&lt; highlight txt >}}
git clone <https://github.com/owncloud/ocis-glauth.git>
{{< highlight txt >}}
git clone https://github.com/owncloud/ocis-glauth.git
cd ocis-glauth
{{&lt; / highlight >}}
{{< / 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
{{&lt; highlight txt >}}
{{< highlight txt >}}
make generate
make build
{{&lt; / highlight >}}
{{< / highlight >}}
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-glauth -h` to see all available options.

View File

@@ -1,14 +1,13 @@
* * *
---
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: <https://github.com/owncloud/ocis-glauth>
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
geekdocFilePath: getting-started.md
---
## geekdocFilePath: getting-started.md
{{&lt; toc >}}
{{< toc >}}
## Installation
@@ -93,59 +92,59 @@ If you prefer to configure the service with commandline flags you can see the av
#### Global
\--config-file
--config-file
: Path to config file, empty default value
\--log-level
--log-level
: Set logging level, defaults to `info`
\--log-color
--log-color
: Enable colored logging, defaults to `true`
\--log-pretty
--log-pretty
: Enable pretty logging, defaults to `true`
#### Server
\--tracing-enabled
--tracing-enabled
: Enable sending traces, defaults to `false`
\--tracing-type
--tracing-type
: Tracing backend type, defaults to `jaeger`
\--tracing-endpoint
--tracing-endpoint
: Endpoint for the agent, empty default value
\--tracing-collector
--tracing-collector
: Endpoint for the collector, empty default value
\--tracing-service
--tracing-service
: Service name for tracing, defaults to `glauth`
\--debug-addr
--debug-addr
: Address to bind debug server, defaults to `0.0.0.0:9124`
\--debug-token
--debug-token
: Token to grant metrics access, empty default value
\--debug-pprof
--debug-pprof
: Enable pprof debugging, defaults to `false`
\--debug-zpages
--debug-zpages
: Enable zpages debugging, defaults to `false`
\--http-addr
--http-addr
: Address to bind http server, defaults to `0.0.0.0:9120`
\--http-namespace
--http-namespace
: Namespace for internal services communication, defaults to `com.owncloud.web`
\--http-root
--http-root
: Root path of http server, defaults to `/`
#### Health
\--debug-addr
--debug-addr
: Address to debug endpoint, defaults to `0.0.0.0:9124`
### Configuration file
@@ -160,17 +159,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:
{{&lt; highlight txt >}}
{{< highlight txt >}}
ocis-glauth server --help
{{&lt; / highlight >}}
{{< / 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.
{{&lt; highlight txt >}}
{{< highlight txt >}}
ocis-glauth health --help
{{&lt; / highlight >}}
{{< / highlight >}}
## Metrics

View File

@@ -1,11 +1,10 @@
* * *
---
title: "License"
date: 2018-05-02T00:00:00+00:00
weight: 40
geekdocRepo: <https://github.com/owncloud/ocis-glauth>
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
## geekdocFilePath: license.md
geekdocFilePath: license.md
---
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/glauth/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.