From f960f7d8023bf71f6098a18872f9d72ccfccd689 Mon Sep 17 00:00:00 2001 From: Daniel Klaffenbach Date: Tue, 12 Apr 2016 08:22:10 +0200 Subject: [PATCH] Add README --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..98681c6 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +django-fountain +=============== + +Django-fountain is yet another LDAP user sync app. The main difference compared +to existing solution is that it does not sync the entire directory. It only +synchronizes the attributes of existing Django users. + +Installation +------------ + +1. Install `django-fountain` through `pip` +2. Add `fountain` to `INSTALLED_APPS` + +Configuration +------------- + +The following settings may be configured: + +- `LDAP_SYNC_URI`: This needs to be a LDAP **URI**, such as `ldaps://ldap.example.org/ou=Users,dc=example,dc=org` +- `LDAP_SYNC_USER_ATTRIBUTES`: A dictionary mapping LDAP attributes to Django model attributes + +Default values are used if the settings are not present. They may or may not work. + +Regular attribute sync +---------------------- + +Normally attributes are only synced when a user is being created. To update the +all user attributes regularly the following management command may be used: + +```bash +./manage.py ldap_sync +``` -- GitLab