Update README

This commit is contained in:
yo 2023-08-07 14:07:24 +02:00
parent 7b3296d8f4
commit 5a07b47a21

View File

@ -7,7 +7,7 @@ UPDATE: Yay, the day has come!
## Usage ## Usage
Start glapi with parameters on command line: Start glapi with parameters on command line:
``` ```
glapi -ldap-host ldap://ldap.example.org -ldap-base-dn dc=example,dc=org -ldap-user cn=yo,dc=example,dc=org -ldap-pass 'here_is_the_password' glapi -ldap-host ldap://ldap.example.org -ldap-base-dn ou=configurations,dc=example,dc=org -ldap-auth-base-dn ou=users,dc=example,dc=org -ldap-user cn=yo,dc=example,dc=org -ldap-pass 'here_is_the_password'
``` ```
or point it to a configuration file : or point it to a configuration file :
@ -40,7 +40,8 @@ SSL_PRIVATE_KEY=/etc/ssl/private/server.key
## Querying API ## Querying API
### Search Entries ### Search Entries
Search LDAP entries through the whole subtree, specifying organizationalUnit, commnName, objectClass, attribute to retrieve. Search LDAP entries through the whole subtree, specifying organizationalUnit, commnName, objectClass, attribute to retrieve.
Each of these parameters can be replaced by "ALL" to act like a wildcard. Each of these parameters can be replaced by "ALL" to act like a wildcard.
"admin" user should exist in LDAP_AUTH_BASE_DN and searchable with cn=admin
``` ```
% curl -u admin:admin http://127.0.0.1:8080/ou=domains/yo/person | jq % curl -u admin:admin http://127.0.0.1:8080/ou=domains/yo/person | jq
[ [