docs/source/features/ldap.rst

   1 LDAP
   2 ====
   3
   4 .. versionadded:: 0.10
   5
   6 Ganeti Web Manager supports LDAP authentication through the use of
   7 `django-auth-ldap`_ and `python-ldap`_. A fabric command has been
   8 written to easily handle enabling and disabling LDAP support.
   9
  10 .. _ldap-dependencies:
  11
  12 Dependencies
  13 ------------
  14
  15 In order to use `python-ldap`_ a couple of system level packages need to
  16 be installed first.
  17
  18 For a Debian based systems:
  19  * libldap2-dev
  20  * libsasl2-dev
  21
  22 For a Red Hat based systems:
  23  * openldap-devel
  24
  25 Deploying
  26 ---------
  27
  28 To deploy Ganeti Web Manager with LDAP
  29
  30 #. Copy ``ldap_settings.py.dist`` to ``ldap_settings.py``.
  31
  32    ::
  33
  34       $ cp ldap_settings.py.dist ldap_settings.py
  35
  36 #. Change `ldap_settings.py` to fit your LDAP configuration.
  37
  38    ::
  39
  40       $ vi ldap_settings.py
  41
  42    .. note::
  43        ``ldap_settings.py.dist`` has been thoroughly commented so that external
  44        documentation shouldn't be needed. If you have specific questions about
  45        options or want an overview of the package, please consult the
  46        `django-auth-ldap`_ documentation.
  47
  48
  49 #. Run the fabric command to enable LDAP in settings::
  50
  51    $ fab ldap
  52
  53 ``fab ldap`` installs `django-auth-ldap`_ and `python-ldap`_ and takes
  54 care of the commenting and uncommenting the lines in settings.py that
  55 handle LDAP imports.
  56
  57 Disabling
  58 ---------
  59 If you would like to later disable LDAP support, all that is required is
  60 to run::
  61
  62    $ fab ldap:disable
  63
  64 .. note::
  65     This will remove `django-auth-ldap`_ and `python-ldap`_ but will not
  66     remove the system specific dependencies.
  67
  68 .. _python-ldap: http://www.python-ldap.org/doc/html/index.html
  69 .. _django-auth-ldap: http://pythonhosted.org/django-auth-ldap/