Go to file
John Thiltges 6f98076281 Protect against XSS vulnerabilities in URL redirection
- Switch from base64 to URL encoding for the passing the URL, using the built-in Mako filtering
- Apply HTML filtering to Mako output by default
- Disable HTML filtering for nested templates in adduser, modify, and selfmodify
2019-01-02 14:31:10 -06:00
conf adding example for unix socket in defautl conf 2017-06-09 23:24:20 +02:00
docs remove duplicated import in docs conf.py 2017-06-12 19:47:43 +02:00
goodies adding an nginx configuration exmaple for fastcgi 2017-06-09 23:09:11 +02:00
ldapcherry Protect against XSS vulnerabilities in URL redirection 2019-01-02 14:31:10 -06:00
misc fix some errors in unused code 2017-01-31 20:59:49 +01:00
resources Protect against XSS vulnerabilities in URL redirection 2019-01-02 14:31:10 -06:00
scripts implementing debug mode in console 2016-07-06 21:54:08 +02:00
tests remove useless tests 2017-06-12 19:50:42 +02:00
.gitignore ignore .eggs directory 2016-07-07 20:21:10 +02:00
.travis.yml fix setup.py 2017-04-06 20:58:20 +02:00
ChangeLog.rst changelog 2017-04-06 20:52:55 +02:00
LICENSE Initial commit 2014-06-02 19:46:14 +02:00
MANIFEST.in adding manifest 2015-11-03 22:24:27 +01:00
README.rst Update README.rst 2018-02-07 19:54:23 +01:00
requirements.txt changing install order 2015-07-20 00:11:48 +02:00
run_test.sh pretier and cleaner run_test.sh 2015-07-31 20:30:04 +02:00
setup.py fix import of version in docs/conf.py and setup.py 2017-04-06 20:46:58 +02:00

README.rst

**************
  LdapCherry 
**************

.. image:: https://raw.githubusercontent.com/kakwa/ldapcherry/master/resources/static/img/apple-touch-icon-72-precomposed.png

Nice and simple application to manage users and groups in multiple directory services.

.. image:: https://travis-ci.org/kakwa/ldapcherry.svg?branch=master
    :target: https://travis-ci.org/kakwa/ldapcherry
    
.. image:: https://coveralls.io/repos/kakwa/ldapcherry/badge.svg 
    :target: https://coveralls.io/r/kakwa/ldapcherry
    
.. image:: https://img.shields.io/pypi/v/ldapcherry.svg
    :target: https://pypi.python.org/pypi/ldapcherry
    :alt: PyPI version

.. image:: https://readthedocs.org/projects/ldapcherry/badge/?version=latest
    :target: http://ldapcherry.readthedocs.org/en/latest/?badge=latest
    :alt: Documentation Status

----

:Doc:    `LdapCherry documentation on ReadTheDoc <http://ldapcherry.readthedocs.org/en/latest/>`_
:Dev:    `LdapCherry source code on GitHub <https://github.com/kakwa/ldapcherry>`_
:PyPI:   `LdapCherry package on Pypi <http://pypi.python.org/pypi/ldapcherry>`_
:License: MIT
:Author:  Pierre-Francois Carpentier - copyright © 2016

----

********
  Demo
********

A demo is accessible here: https://ldapcherry.kakwalab.ovh

The credentials are:

* as administrator: admin/admin
* as user: user/user

Please take note that it's not possible to modify/delete the 'admin' and 'user' users.

Also take note that the service will be reseted once per day.

****************
  Presentation
****************

LdapCherry is a CherryPY application to manage users and groups in multiple directory services.

Its main features are:

* manage multiple directories/databases backends in an unified way
* roles management (as in "groups of groups")
* autofill forms
* password policy
* self modification of some selected fields by normal (non administrator) users
* nice bootstrap interface
* modular through pluggable authentication, password policy and backend modules

LdapCherry is not limited to ldap, it can handle virtually any user backend (ex: SQL database, htpasswd file, etc)
through the proper plugin (provided that it is implemented ^^).

LdapCherry also aims to be as simple as possible to deploy: no crazy dependencies, 
few configuration files, extensive debug logs and full documentation.

The default backend plugins permit to manage Ldap and Active Directory.

***************
  Screenshots
***************

`Screenshots <http://ldapcherry.readthedocs.org/en/latest/screenshots.html#image1>`_.

***********
  Try out
***********

.. sourcecode:: bash

    # clone the repository
    $ git clone https://github.com/kakwa/ldapcherry && cd ldapcherry

    # change the directory where to put the configuration (default: /etc)
    $ export SYSCONFDIR=/etc
    # change the directory where to put the resource (default: /usr/share)
    $ export DATAROOTDIR=/usr/share/
    
    # install ldapcherry
    $ python setup.py

    # edit configuration files
    $ vi /etc/ldapcherry/ldapcherry.ini
    $ vi /etc/ldapcherry/roles.yml
    $ vi /etc/ldapcherry/attributes.yml

    # launch ldapcherry
    $ ldapcherryd -c /etc/ldapcherry/ldapcherry.ini -D


***********
  License
***********

LdapCherry is published under the MIT Public License.

*******************************
  Discussion / Help / Updates
*******************************

* IRC: `Freenode <http://freenode.net/>`_ ``#ldapcherry`` channel
* Bugtracker: `Github <https://github.com/kakwa/ldapcherry/issues>`_

----

.. image:: https://raw.githubusercontent.com/kakwa/ldapcherry/master/docs/assets/python-powered.png
.. image:: https://raw.githubusercontent.com/kakwa/ldapcherry/master/docs/assets/cherrypy.png