yo/glapi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
yo 2023-08-07 14:01:04 +02:00
parent c74855d064
commit 7b3296d8f4
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -19,6 +19,7 @@ glapi -config glapi.env
``` ```
LISTEN="0.0.0.0:8443" LISTEN="0.0.0.0:8443"
LDAP_HOST="ldap://ldap.example.org" LDAP_HOST="ldap://ldap.example.org"
# The base DN exposed to API. Could be buried in LDAP tree so we expose only a subset of directory.
LDAP_BASE_DN="dc=example,dc=org" LDAP_BASE_DN="dc=example,dc=org"
# This account search for valid user provided by authenticating client. # This account search for valid user provided by authenticating client.
@ -27,6 +28,9 @@ LDAP_BASE_DN="dc=example,dc=org"
LDAP_USER="cn=ldapreaduser,dc=example,dc=org" LDAP_USER="cn=ldapreaduser,dc=example,dc=org"
LDAP_PASS='here_lies_the_password' LDAP_PASS='here_lies_the_password'
# This base DN is where we seach for authenticating accounts. This way we can chose not to expose them to the API.
LDAP_AUTH_BASE_DN="ou=users,dc=example,dc=org"
# Https support # Https support
HTTPS=true HTTPS=true
SSL_CERTIFICATE=/etc/ssl/certs/server.pem SSL_CERTIFICATE=/etc/ssl/certs/server.pem

2
glapi.env.sample
View File

@ -3,7 +3,7 @@ LDAP_HOST="ldap://ldap.example.org"
# The base DN exposed to API. Could be buried in LDAP tree so we expose only a subset of directory. # The base DN exposed to API. Could be buried in LDAP tree so we expose only a subset of directory.
LDAP_BASE_DN="ou=configuration,dc=example,dc=org" LDAP_BASE_DN="ou=configuration,dc=example,dc=org"
# This account search for valid user provided by authenticating client. # This account search for valid users provided by authenticating clients.
# Then glapi bind with client provided credentials to operate LDAP. # Then glapi bind with client provided credentials to operate LDAP.
# Thus this account only needs bind privilege, and read access to users organizational unit # Thus this account only needs bind privilege, and read access to users organizational unit
LDAP_USER="cn=ldapreaduser,dc=example,dc=org" LDAP_USER="cn=ldapreaduser,dc=example,dc=org"