Commit f960f7d8 authored by Daniel Klaffenbach's avatar Daniel Klaffenbach 🐍

Add README

parent 7df385d3
Pipeline #1418 skipped
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
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment