1
0
Fork 0

Add some documentation

This commit is contained in:
Sandro - 2022-12-25 23:57:01 +01:00
parent 7169365fd8
commit 5e62b87f01
Signed by: sandro
GPG Key ID: 3AF5A43A3EECC2E5
1 changed files with 17 additions and 0 deletions

17
hosts/auth/README.md Normal file
View File

@ -0,0 +1,17 @@
# Design
We are using [portunus](https://github.com/majewsky/portunus) to manage an OpenLDAP server
and currently [dex](https://dexidp.io/) to offer OIDC.
Dex might be replaced in the future with an equivalent solution that can remember sessions to have true SSO.
New services should use OAuth/OIDC if possible to lay the groundwork for SSO.
If the application only support LDAP, that is also fine to use.
# How to use it
See the grafana configuration to see an example on how to use OAuth.
To create a new application edit the dex configuration next to portunus.
The aplication credentials are saved in sops.
For an exmaple ldap configuration see the gitea, hydra or mailtngbert.
The ldap settings are documented in portunus in detail.
To connect to `auth.c3d2.de` the nixos-modules option `services.portunus.addToHosts` should be set to true.