Update readme

This commit is contained in:
cazagen 2020-02-15 00:08:13 +00:00
parent bec130fc0b
commit d425b397cf

View File

@ -1,45 +1,9 @@
OctoPrint LDAP auth Plugin
This plugin allow users to be connected using an LDAP server.
This system works
You will need to run the following command before installing this plugin
`sudo apt-get install libsasl2-dev python-dev libldap2-dev libssl-dev`
#### Details
Install from the plugin manager.
When you try to login, OctoPrint search for user in this local database (users.yaml)
- If it found a user, check if this user exists also on LDAP
- If user exists on LDAP, use LDAP bind() to check login / password
- If user not exists on LDAP, use native password system to check it
- If it not found a user in local database, try to connect directly on LDAP
- If login on LDAP il OK, a new local user is added with role "user" and a random password (password should never be used)
- User is connected
- An admin (default user for exemple), could change a user permissions or account state.
- Password of LDAP users can't be changed
#### Configuration
You could configure LDAP server in plugin config, or manually in config.yaml
ldap_uri: ldaps://ldap.server.com/
ldap_tls_reqcert: demand
ldap_search_base: dc=server,dc=com
groups: TheGroupName
#### Groups
- You can list multiple groups via comma seperation: Group1, Group2, Group3.
- Leaving blank will skip a group check.
#### Installation
You can install it using ```pip install https://github.com/gillg/OctoPrint-LDAP/archive/master.zip```
Or with plugin manager into OctoPrint
The group is hardcoded... Sorry.