django-ldap-sync 0.4.3 has two required prerequisites:

The automatic installation options below will install or update python-ldap as necessary. Earlier versions of these dependencies may work, but are not tested or supported.


There are several different ways to install django-ldap-sync, depending on your preferences and needs. In all cases, it is recommended to run the installation within a virtualenv for isolation from other Python system packages.

Via pip

The easiest installation method is with pip:

pip install django-ldap-sync

Via a downloaded package

If you cannot access pip or prefer to install the package manually, download the tarball from PyPI. Extract the downloaded archive and install it with:

python install

Via GitHub

To stay current with the latest development, clone the active development repository on GitHub:

git clone git://

If you don’t want a full git repository, download the latest code from GitHub as a tarball.


Add django-ldap-sync to the INSTALLED_APPS setting within your project’s (or equivalent) file:

    # ...

django-ldap-sync has a number of required settings that need to be configured before it can operate. See the Settings documentation for a complete list of the required and optional settings.


Typically you will want to run this management command on a regular basis to keep the users synchronized. There are several ways to accomplish this depending on your needs and environment.


The management command can always be run manually, which might be sufficient for some simple or relatively static environments. Run the command with:

python ldap_sync


The next logical step from running the command manually is to automate running it on a regular basis with cron (or your system’s equivalent). The implementation details depend on your system and environment. If you do not have access to the local system cron, consider django-cron or django-poormanscron.


Another methodology is to run the command as a periodic Celery task. Particularly if you already have Celery available, this can be a good way to run the command in a more distributed fashion. django-ldap-sync comes with a Celery task that wraps the management command, so only some additional configuration is required within your project’s file:

from datetime import timedelta

    'synchronize_local_users': {
        'task': 'ldap_sync.tasks.syncldap',
        'schedule': timedelta(minutes=30),

For more information and other configuration options, see the Celery documentation on periodic tasks.