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
+93 -92
View File
@@ -1,4 +1,4 @@
# Changelog for [unreleased] \(UNRELEASED)
# Changelog for [unreleased] (UNRELEASED)
The following sections list the changes in ocis-glauth unreleased.
@@ -6,55 +6,55 @@ The following sections list the changes in ocis-glauth unreleased.
## Summary
- Bugfix - Return invalid credentials when user was not found: [#30](https://github.com/owncloud/ocis/glauth/pull/30)
- Bugfix - Query numeric attribute values without quotes: [#28](https://github.com/owncloud/ocis/glauth/issues/28)
- Bugfix - Use searchBaseDN if already a user/group name: [#214](https://github.com/owncloud/product/issues/214)
- Bugfix - Fix LDAP substring startswith filters: [#31](https://github.com/owncloud/ocis/glauth/pull/31)
* Bugfix - Return invalid credentials when user was not found: [#30](https://github.com/owncloud/ocis/glauth/pull/30)
* Bugfix - Query numeric attribute values without quotes: [#28](https://github.com/owncloud/ocis/glauth/issues/28)
* Bugfix - Use searchBaseDN if already a user/group name: [#214](https://github.com/owncloud/product/issues/214)
* Bugfix - Fix LDAP substring startswith filters: [#31](https://github.com/owncloud/ocis/glauth/pull/31)
## Details
- Bugfix - Return invalid credentials when user was not found: [#30](https://github.com/owncloud/ocis/glauth/pull/30)
* Bugfix - Return invalid credentials when user was not found: [#30](https://github.com/owncloud/ocis/glauth/pull/30)
We were relying on an error code of the ListAccounts call when the username and password was
wrong. But the list will be empty if no user with the given login was found. So we also need to check
if the list of accounts is empty.
We were relying on an error code of the ListAccounts call when the username and password was
wrong. But the list will be empty if no user with the given login was found. So we also need to check
if the list of accounts is empty.
<https://github.com/owncloud/ocis/glauth/pull/30>
https://github.com/owncloud/ocis/glauth/pull/30
- Bugfix - Query numeric attribute values without quotes: [#28](https://github.com/owncloud/ocis/glauth/issues/28)
* Bugfix - Query numeric attribute values without quotes: [#28](https://github.com/owncloud/ocis/glauth/issues/28)
Some LDAP properties like `uidnumber` and `gidnumber` are numeric. When an OS tries to look up a
user it will not only try to lookup the user by username, but also by the `uidnumber`:
`(&(objectclass=posixAccount)(uidnumber=20000))`. The accounts backend for glauth was
sending that as a string query `uid_number eq '20000'` in the ListAccounts query. This PR
changes that to `uid_number eq 20000`. The removed quotes allow the parser in ocis-accounts to
identify the numeric literal.
Some LDAP properties like `uidnumber` and `gidnumber` are numeric. When an OS tries to look up a
user it will not only try to lookup the user by username, but also by the `uidnumber`:
`(&(objectclass=posixAccount)(uidnumber=20000))`. The accounts backend for glauth was
sending that as a string query `uid_number eq '20000'` in the ListAccounts query. This PR
changes that to `uid_number eq 20000`. The removed quotes allow the parser in ocis-accounts to
identify the numeric literal.
<https://github.com/owncloud/ocis/glauth/issues/28>
<https://github.com/owncloud/ocis/glauth/pull/29>
<https://github.com/owncloud/ocis/accounts/pull/68>
https://github.com/owncloud/ocis/glauth/issues/28
https://github.com/owncloud/ocis/glauth/pull/29
https://github.com/owncloud/ocis/accounts/pull/68
- Bugfix - Use searchBaseDN if already a user/group name: [#214](https://github.com/owncloud/product/issues/214)
* Bugfix - Use searchBaseDN if already a user/group name: [#214](https://github.com/owncloud/product/issues/214)
In case of the searchBaseDN already referencing a user or group, the search query was ignoring
the user/group name entirely, because the searchBaseDN is not part of the LDAP filters. We
fixed this by including an additional query part if the searchBaseDN contains a CN.
In case of the searchBaseDN already referencing a user or group, the search query was ignoring
the user/group name entirely, because the searchBaseDN is not part of the LDAP filters. We
fixed this by including an additional query part if the searchBaseDN contains a CN.
<https://github.com/owncloud/product/issues/214>
<https://github.com/owncloud/ocis/glauth/pull/32>
https://github.com/owncloud/product/issues/214
https://github.com/owncloud/ocis/glauth/pull/32
- Bugfix - Fix LDAP substring startswith filters: [#31](https://github.com/owncloud/ocis/glauth/pull/31)
* Bugfix - Fix LDAP substring startswith filters: [#31](https://github.com/owncloud/ocis/glauth/pull/31)
Filters like `(mail=mar*)` are currentld not parsed correctly, but they are used when
searching for recipients. This PR correctly converts them to odata filters like
`startswith(mail,'mar')`.
Filters like `(mail=mar*)` are currentld not parsed correctly, but they are used when
searching for recipients. This PR correctly converts them to odata filters like
`startswith(mail,'mar')`.
<https://github.com/owncloud/ocis/glauth/pull/31>
https://github.com/owncloud/ocis/glauth/pull/31
# Changelog for [0.5.0] \(2020-07-23)
# Changelog for [0.5.0] (2020-07-23)
The following sections list the changes in ocis-glauth 0.5.0.
@@ -62,44 +62,44 @@ The following sections list the changes in ocis-glauth 0.5.0.
## Summary
- Bugfix - Ignore case when comparing objectclass values: [#26](https://github.com/owncloud/ocis/glauth/pull/26)
- Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#24](https://github.com/owncloud/ocis/glauth/pull/24)
- Enhancement - Handle ownCloudUUID attribute: [#27](https://github.com/owncloud/ocis/glauth/pull/27)
- Enhancement - Implement group queries: [#22](https://github.com/owncloud/ocis/glauth/issues/22)
* Bugfix - Ignore case when comparing objectclass values: [#26](https://github.com/owncloud/ocis/glauth/pull/26)
* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#24](https://github.com/owncloud/ocis/glauth/pull/24)
* Enhancement - Handle ownCloudUUID attribute: [#27](https://github.com/owncloud/ocis/glauth/pull/27)
* Enhancement - Implement group queries: [#22](https://github.com/owncloud/ocis/glauth/issues/22)
## Details
- Bugfix - Ignore case when comparing objectclass values: [#26](https://github.com/owncloud/ocis/glauth/pull/26)
* Bugfix - Ignore case when comparing objectclass values: [#26](https://github.com/owncloud/ocis/glauth/pull/26)
The LDAP equality comparison is specified as case insensitive. We fixed the comparison for
objectclass properties.
The LDAP equality comparison is specified as case insensitive. We fixed the comparison for
objectclass properties.
<https://github.com/owncloud/ocis/glauth/pull/26>
https://github.com/owncloud/ocis/glauth/pull/26
- Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#24](https://github.com/owncloud/ocis/glauth/pull/24)
* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#24](https://github.com/owncloud/ocis/glauth/pull/24)
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/glauth/pull/24>
https://github.com/owncloud/ocis/glauth/pull/24
- Enhancement - Handle ownCloudUUID attribute: [#27](https://github.com/owncloud/ocis/glauth/pull/27)
* Enhancement - Handle ownCloudUUID attribute: [#27](https://github.com/owncloud/ocis/glauth/pull/27)
Clients can now query an accounts immutable id by using the [new `ownCloudUUID`
attribute](https://github.com/butonic/owncloud-ldap-schema/blob/master/owncloud.schema#L28-L34).
Clients can now query an accounts immutable id by using the [new `ownCloudUUID`
attribute](https://github.com/butonic/owncloud-ldap-schema/blob/master/owncloud.schema#L28-L34).
<https://github.com/owncloud/ocis/glauth/pull/27>
https://github.com/owncloud/ocis/glauth/pull/27
- Enhancement - Implement group queries: [#22](https://github.com/owncloud/ocis/glauth/issues/22)
* Enhancement - Implement group queries: [#22](https://github.com/owncloud/ocis/glauth/issues/22)
Refactored the handler and implemented group queries.
Refactored the handler and implemented group queries.
<https://github.com/owncloud/ocis/glauth/issues/22>
<https://github.com/owncloud/ocis/glauth/pull/23>
https://github.com/owncloud/ocis/glauth/issues/22
https://github.com/owncloud/ocis/glauth/pull/23
# Changelog for [0.4.0] \(2020-03-18)
# Changelog for [0.4.0] (2020-03-18)
The following sections list the changes in ocis-glauth 0.4.0.
@@ -107,43 +107,43 @@ The following sections list the changes in ocis-glauth 0.4.0.
## Summary
- Enhancement - Configuration: [#11](https://github.com/owncloud/ocis/glauth/pull/11)
- Enhancement - Improve default settings: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
- Enhancement - Generate temporary ldap certificates if LDAPS is enabled: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
- Enhancement - Provide additional tls-endpoint: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
* Enhancement - Configuration: [#11](https://github.com/owncloud/ocis/glauth/pull/11)
* Enhancement - Improve default settings: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
* Enhancement - Generate temporary ldap certificates if LDAPS is enabled: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
* Enhancement - Provide additional tls-endpoint: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
## Details
- Enhancement - Configuration: [#11](https://github.com/owncloud/ocis/glauth/pull/11)
* Enhancement - Configuration: [#11](https://github.com/owncloud/ocis/glauth/pull/11)
Extensions should be responsible of configuring themselves. We use Viper for config loading
from default paths. Environment variables **WILL** take precedence over config files.
Extensions should be responsible of configuring themselves. We use Viper for config loading
from default paths. Environment variables **WILL** take precedence over config files.
<https://github.com/owncloud/ocis/glauth/pull/11>
https://github.com/owncloud/ocis/glauth/pull/11
- Enhancement - Improve default settings: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
* Enhancement - Improve default settings: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
This helps achieve zero-config in single-binary.
This helps achieve zero-config in single-binary.
<https://github.com/owncloud/ocis/glauth/pull/12>
https://github.com/owncloud/ocis/glauth/pull/12
- Enhancement - Generate temporary ldap certificates if LDAPS is enabled: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
* Enhancement - Generate temporary ldap certificates if LDAPS is enabled: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
This change helps to achieve zero-configuration in single-binary mode.
This change helps to achieve zero-configuration in single-binary mode.
<https://github.com/owncloud/ocis/glauth/pull/12>
https://github.com/owncloud/ocis/glauth/pull/12
- Enhancement - Provide additional tls-endpoint: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
* Enhancement - Provide additional tls-endpoint: [#12](https://github.com/owncloud/ocis/glauth/pull/12)
Ocis-glauth is now able to concurrently serve a encrypted and an unencrypted ldap-port.
Please note that only SSL (no StarTLS) is supported at the moment.
Ocis-glauth is now able to concurrently serve a encrypted and an unencrypted ldap-port.
Please note that only SSL (no StarTLS) is supported at the moment.
<https://github.com/owncloud/ocis/glauth/pull/12>
https://github.com/owncloud/ocis/glauth/pull/12
# Changelog for [0.2.0] \(2020-03-17)
# Changelog for [0.2.0] (2020-03-17)
The following sections list the changes in ocis-glauth 0.2.0.
@@ -151,21 +151,21 @@ The following sections list the changes in ocis-glauth 0.2.0.
## Summary
- Change - Default to config based user backend: [#6](https://github.com/owncloud/ocis/glauth/pull/6)
* Change - Default to config based user backend: [#6](https://github.com/owncloud/ocis/glauth/pull/6)
## Details
- Change - Default to config based user backend: [#6](https://github.com/owncloud/ocis/glauth/pull/6)
* Change - Default to config based user backend: [#6](https://github.com/owncloud/ocis/glauth/pull/6)
We changed the default configuration to use the config file backend instead of the ownCloud
backend.
We changed the default configuration to use the config file backend instead of the ownCloud
backend.
The config backend currently only has two hard coded users: demo and admin. To switch back to the
ownCloud backend use `GLAUTH_BACKEND_DATASTORE=owncloud`
The config backend currently only has two hard coded users: demo and admin. To switch back to the
ownCloud backend use `GLAUTH_BACKEND_DATASTORE=owncloud`
<https://github.com/owncloud/ocis/glauth/pull/6>
https://github.com/owncloud/ocis/glauth/pull/6
# Changelog for [0.3.0] \(2020-03-17)
# Changelog for [0.3.0] (2020-03-17)
The following sections list the changes in ocis-glauth 0.3.0.
@@ -173,21 +173,21 @@ The following sections list the changes in ocis-glauth 0.3.0.
## Summary
- Change - Use physicist demo users: [#5](https://github.com/owncloud/ocis/glauth/issues/5)
* Change - Use physicist demo users: [#5](https://github.com/owncloud/ocis/glauth/issues/5)
## Details
- Change - Use physicist demo users: [#5](https://github.com/owncloud/ocis/glauth/issues/5)
* Change - Use physicist demo users: [#5](https://github.com/owncloud/ocis/glauth/issues/5)
Demo users like admin, demo and test don't allow you to tell a story. Which is why we changed the
set of hard coded demo users to `einstein`, `marie` and `feynman`. You should know who they are.
This also changes the ldap domain from `dc=owncloud,dc=com` to `dc=example,dc=org` because
that is what these users use as their email domain. There are also `konnectd` and `reva` for
technical purposes, eg. to allow konnectd and reva to bind to glauth.
Demo users like admin, demo and test don't allow you to tell a story. Which is why we changed the
set of hard coded demo users to `einstein`, `marie` and `feynman`. You should know who they are.
This also changes the ldap domain from `dc=owncloud,dc=com` to `dc=example,dc=org` because
that is what these users use as their email domain. There are also `konnectd` and `reva` for
technical purposes, eg. to allow konnectd and reva to bind to glauth.
<https://github.com/owncloud/ocis/glauth/issues/5>
https://github.com/owncloud/ocis/glauth/issues/5
# Changelog for [0.1.0] \(2020-02-28)
# Changelog for [0.1.0] (2020-02-28)
The following sections list the changes in ocis-glauth 0.1.0.
@@ -195,12 +195,13 @@ The following sections list the changes in ocis-glauth 0.1.0.
## Summary
- Enhancement - Initial release of basic version: [#1](https://github.com/owncloud/ocis/glauth/pull/1)
* Enhancement - Initial release of basic version: [#1](https://github.com/owncloud/ocis/glauth/pull/1)
## Details
- Enhancement - Initial release of basic version: [#1](https://github.com/owncloud/ocis/glauth/pull/1)
* Enhancement - Initial release of basic version: [#1](https://github.com/owncloud/ocis/glauth/pull/1)
Just prepare an initial basic version to provide a glauth service.
Just prepare an initial basic version to provide a glauth service.
https://github.com/owncloud/ocis/glauth/pull/1
<https://github.com/owncloud/ocis/glauth/pull/1>
+2 -2
View File
@@ -2,7 +2,7 @@
[![Build Status](https://cloud.drone.io/api/badges/owncloud/ocis-glauth/status.svg)](https://cloud.drone.io/owncloud/ocis-glauth)
[![Gitter chat](https://badges.gitter.im/cs3org/reva.svg)](https://gitter.im/cs3org/reva)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/6f1eaaa399294d959ef7b3b10deed41d)](https://www.codacy.com/manual/owncloud/ocis-glauth?utm_source=github.com&utm_medium=referral&utm_content=owncloud/ocis-glauth&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/6f1eaaa399294d959ef7b3b10deed41d)](https://www.codacy.com/manual/owncloud/ocis-glauth?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=owncloud/ocis-glauth&amp;utm_campaign=Badge_Grade)
[![Go Doc](https://godoc.org/github.com/owncloud/ocis-glauth?status.svg)](http://godoc.org/github.com/owncloud/ocis-glauth)
[![Go Report](http://goreportcard.com/badge/github.com/owncloud/ocis-glauth)](http://goreportcard.com/report/github.com/owncloud/ocis-glauth)
[![](https://images.microbadger.com/badges/image/owncloud/ocis-glauth.svg)](http://microbadger.com/images/owncloud/ocis-glauth "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](mailto:security@owncloud.com) first.
If you find a security issue please contact security@owncloud.com first.
## Contributing
@@ -2,4 +2,4 @@ Enhancement: Initial release of basic version
Just prepare an initial basic version to provide a glauth service.
<https://github.com/owncloud/ocis/glauth/pull/1>
https://github.com/owncloud/ocis/glauth/pull/1
+1 -1
View File
@@ -4,4 +4,4 @@ We changed the default configuration to use the config file backend instead of t
The config backend currently only has two hard coded users: demo and admin. To switch back to the ownCloud backend use `GLAUTH_BACKEND_DATASTORE=owncloud`
<https://github.com/owncloud/ocis/glauth/pull/6>
https://github.com/owncloud/ocis/glauth/pull/6
@@ -2,4 +2,4 @@ Change: use physicist demo users
Demo users like admin, demo and test don't allow you to tell a story. Which is why we changed the set of hard coded demo users to `einstein`, `marie` and `feynman`. You should know who they are. This also changes the ldap domain from `dc=owncloud,dc=com` to `dc=example,dc=org` because that is what these users use as their email domain. There are also `konnectd` and `reva` for technical purposes, eg. to allow konnectd and reva to bind to glauth.
<https://github.com/owncloud/ocis/glauth/issues/5>
https://github.com/owncloud/ocis/glauth/issues/5
@@ -2,4 +2,4 @@ Enhancement: Improve default settings
This helps achieve zero-config in single-binary.
<https://github.com/owncloud/ocis/glauth/pull/12>
https://github.com/owncloud/ocis/glauth/pull/12
@@ -2,4 +2,4 @@ Enhancement: Generate temporary ldap certificates if LDAPS is enabled
This change helps to achieve zero-configuration in single-binary mode.
<https://github.com/owncloud/ocis/glauth/pull/12>
https://github.com/owncloud/ocis/glauth/pull/12
@@ -3,4 +3,4 @@ Enhancement: Provide additional tls-endpoint
ocis-glauth is now able to concurrently serve a encrypted and an unencrypted ldap-port. Please note that only
SSL (no StarTLS) is supported at the moment.
<https://github.com/owncloud/ocis/glauth/pull/12>
https://github.com/owncloud/ocis/glauth/pull/12
@@ -2,4 +2,5 @@ Enhancement: handle ownCloudUUID attribute
Clients can now query an accounts immutable id by using the [new `ownCloudUUID` attribute](https://github.com/butonic/owncloud-ldap-schema/blob/master/owncloud.schema#L28-L34).
<https://github.com/owncloud/ocis/glauth/pull/27>
https://github.com/owncloud/ocis/glauth/pull/27
@@ -2,4 +2,4 @@ Bugfix: ignore case when comparing objectclass values
The LDAP equality comparison is specified as case insensitive. We fixed the comparison for objectclass properties.
<https://github.com/owncloud/ocis/glauth/pull/26>
https://github.com/owncloud/ocis/glauth/pull/26
@@ -2,5 +2,5 @@ Enhancement: implement group queries
Refactored the handler and implemented group queries.
<https://github.com/owncloud/ocis/glauth/issues/22>
<https://github.com/owncloud/ocis/glauth/pull/23>
https://github.com/owncloud/ocis/glauth/issues/22
https://github.com/owncloud/ocis/glauth/pull/23
@@ -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/glauth/pull/24>
https://github.com/owncloud/ocis/glauth/pull/24
@@ -2,4 +2,4 @@ Bugfix: return invalid credentials when user was not found
We were relying on an error code of the ListAccounts call when the username and password was wrong. But the list will be empty if no user with the given login was found. So we also need to check if the list of accounts is empty.
<https://github.com/owncloud/ocis/glauth/pull/30>
https://github.com/owncloud/ocis/glauth/pull/30
@@ -2,6 +2,6 @@ Bugfix: query numeric attribute values without quotes
Some LDAP properties like `uidnumber` and `gidnumber` are numeric. When an OS tries to look up a user it will not only try to lookup the user by username, but also by the `uidnumber`: `(&(objectclass=posixAccount)(uidnumber=20000))`. The accounts backend for glauth was sending that as a string query `uid_number eq '20000'` in the ListAccounts query. This PR changes that to `uid_number eq 20000`. The removed quotes allow the parser in ocis-accounts to identify the numeric literal.
<https://github.com/owncloud/ocis/glauth/issues/28>
<https://github.com/owncloud/ocis/glauth/pull/29>
<https://github.com/owncloud/ocis/accounts/pull/68>
https://github.com/owncloud/ocis/glauth/issues/28
https://github.com/owncloud/ocis/glauth/pull/29
https://github.com/owncloud/ocis/accounts/pull/68
@@ -2,5 +2,5 @@ Bugfix: Use searchBaseDN if already a user/group name
In case of the searchBaseDN already referencing a user or group, the search query was ignoring the user/group name entirely, because the searchBaseDN is not part of the LDAP filters. We fixed this by including an additional query part if the searchBaseDN contains a CN.
<https://github.com/owncloud/product/issues/214>
<https://github.com/owncloud/ocis/glauth/pull/32>
https://github.com/owncloud/product/issues/214
https://github.com/owncloud/ocis/glauth/pull/32
@@ -2,4 +2,4 @@ Bugfix: fix LDAP substring startswith filters
Filters like `(mail=mar*)` are currentld not parsed correctly, but they are used when searching for recipients. This PR correctly converts them to odata filters like `startswith(mail,'mar')`.
<https://github.com/owncloud/ocis/glauth/pull/31>
https://github.com/owncloud/ocis/glauth/pull/31
+7 -8
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
+10 -11
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.
+26 -27
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
+4 -5
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.