Fix docs formatting

This commit is contained in:
Michael Barz
2020-02-27 17:12:38 +01:00
parent bed54f13b7
commit 87f22a8741
6 changed files with 43 additions and 26 deletions

View File

@@ -11,7 +11,7 @@
## Install
You can download prebuilt binaries from the GitHub releases or from our [download mirrors](http://download.owncloud.com/ocis/glauth/). For instructions how to install this on your platform you should take a look at our [documentation](https://owncloud.github.io/ocis-glauth/)
You can download prebuilt binaries from the GitHub releases or from our [download mirrors](http://download.owncloud.com/ocis/glauth/). For instructions how to install this on your platform you should take a look at our [documentation](https://owncloud.github.io/extensions/ocis_glauth/)
## Development

View File

@@ -2,7 +2,7 @@
{{- range $index, $changes := . }}{{ with $changes -}}
# Changelog for [{{ .Version }}] ({{ .Date }})
The following sections list the changes for {{ .Version }}.
The following sections list the changes in ocis-glauth {{ .Version }}.
{{ if gt (len $allVersions) 1 -}}
{{/* creating version compare links */ -}}
@@ -27,12 +27,12 @@ The following sections list the changes for {{ .Version }}.
## Summary
{{ range $entry := .Entries }}{{ with $entry }}
* {{ .Type }} #{{ .PrimaryID }}: {{ .Title }}
* {{ .Type }} - {{ .Title }}: [#{{ .PrimaryID }}]({{ .PrimaryURL }})
{{- end }}{{ end }}
## Details
{{ range $entry := .Entries }}{{ with $entry }}
* {{ .Type }} #{{ .PrimaryID }}: {{ .Title }}
* {{ .Type }} - {{ .Title }}: [#{{ .PrimaryID }}]({{ .PrimaryURL }})
{{ range $par := .Paragraphs }}
{{ wrapIndent $par 80 3 }}
{{ end -}}

View File

@@ -1,6 +1,10 @@
---
title: "GLAuth"
anchor: "ocis-glauth"
date: 2018-05-02T00:00:00+00:00
weight: 10
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
geekdocFilePath: _index.md
---
This service provides a simple glauth world API which can be used by clients or other extensions.

View File

@@ -1,10 +1,14 @@
---
title: "Building"
date: 2018-05-02T00:00:00+00:00
anchor: "building"
weight: 30
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
geekdocFilePath: building.md
---
{{< 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 >}}
@@ -14,7 +18,7 @@ cd ocis-glauth
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
## Backend
{{< highlight txt >}}
make generate

View File

@@ -1,31 +1,35 @@
---
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
anchor: "getting-started"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
geekdocFilePath: getting-started.md
---
### Installation
{{< toc >}}
## Installation
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
### Docker
TBD
#### Binaries
### Binaries
TBD
### Configuration
## Configuration
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
#### Envrionment variables
### Envrionment variables
If you prefer to configure the service with environment variables you can see the available variables below.
##### Global
#### Global
GLAUTH_CONFIG_FILE
: Path to config file, empty default value
@@ -39,7 +43,7 @@ GLAUTH_LOG_COLOR
GLAUTH_LOG_PRETTY
: Enable pretty logging, defaults to `true`
##### Server
#### Server
GLAUTH_TRACING_ENABLED
: Enable sending traces, defaults to `false`
@@ -71,19 +75,22 @@ GLAUTH_DEBUG_ZPAGES
GLAUTH_HTTP_ADDR
: Address to bind http server, defaults to `0.0.0.0:9120`
GLAUTH_HTTP_NAMESPACE
: The http namespace
GLAUTH_HTTP_ROOT
: Root path of http server, defaults to `/`
##### Health
#### Health
GLAUTH_DEBUG_ADDR
: Address to debug endpoint, defaults to `0.0.0.0:9124`
#### Commandline flags
### Commandline flags
If you prefer to configure the service with commandline flags you can see the available variables below.
##### Global
#### Global
--config-file
: Path to config file, empty default value
@@ -97,7 +104,7 @@ If you prefer to configure the service with commandline flags you can see the av
--log-pretty
: Enable pretty logging, defaults to `true`
##### Server
#### Server
--tracing-enabled
: Enable sending traces, defaults to `false`
@@ -135,20 +142,20 @@ If you prefer to configure the service with commandline flags you can see the av
--http-root
: Root path of http server, defaults to `/`
##### Health
#### Health
--debug-addr
: Address to debug endpoint, defaults to `0.0.0.0:9124`
#### Configuration file
### 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](https://github.com/owncloud/ocis-glauth/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/glauth.yml`, `${HOME}/.ocis/glauth.yml` or `$(pwd)/config/glauth.yml`.
### Usage
## Usage
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-glauth --help`.
#### Server
### Server
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:
@@ -156,7 +163,7 @@ The server command is used to start the http and debug server on two addresses w
ocis-glauth server --help
{{< / highlight >}}
#### Health
### 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.
@@ -164,7 +171,7 @@ The health command is used to execute a health check, if the exit code equals ze
ocis-glauth health --help
{{< / highlight >}}
### Metrics
## 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 `GLAUTH_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9124/metrics`.

View File

@@ -1,8 +1,10 @@
---
title: "License"
date: 2018-05-02T00:00:00+00:00
anchor: "license"
weight: 40
geekdocRepo: https://github.com/owncloud/ocis-glauth
geekdocEditPath: edit/master/docs
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.