README.md 962 Bytes
Newer Older
Daniel Klaffenbach's avatar
Daniel Klaffenbach committed
1 2 3 4
django-fountain
===============

Django-fountain is yet another LDAP user sync app. The main difference compared
Daniel Klaffenbach's avatar
Daniel Klaffenbach committed
5
to existing solutions is that it does not sync the entire directory. It only
Daniel Klaffenbach's avatar
Daniel Klaffenbach committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
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
Daniel Klaffenbach's avatar
Daniel Klaffenbach committed
28
attributes of all users regularly the following management command may be used:
Daniel Klaffenbach's avatar
Daniel Klaffenbach committed
29 30 31 32

```bash
./manage.py ldap_sync
```