1
0
mirror of https://github.com/kakwa/ldapcherry synced 2024-11-24 10:14:31 +01:00
ldapcherry/README.rst

105 lines
3.3 KiB
ReStructuredText
Raw Permalink Normal View History

2015-07-17 00:53:23 +02:00
**************
2015-07-06 09:34:22 +02:00
LdapCherry
2015-07-17 00:53:23 +02:00
**************
2015-07-06 09:34:22 +02:00
2015-11-03 01:52:06 +01:00
.. image:: https://raw.githubusercontent.com/kakwa/ldapcherry/master/resources/static/img/apple-touch-icon-72-precomposed.png
2015-07-18 00:35:07 +02:00
Nice and simple application to manage users and groups in multiple directory services.
2015-07-06 09:34:22 +02:00
2015-07-21 08:39:15 +02:00
.. 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/dm/ldapcherry.svg
:target: https://pypi.python.org/pypi/ldapcherry
:alt: Number of PyPI downloads
.. image:: https://img.shields.io/pypi/v/ldapcherry.svg
:target: https://pypi.python.org/pypi/ldapcherry
:alt: PyPI version
2015-11-03 01:56:21 +01:00
.. image:: https://readthedocs.org/projects/ldapcherry/badge/?version=latest
:target: http://ldapcherry.readthedocs.org/en/latest/?badge=latest
:alt: Documentation Status
2015-07-06 09:34:22 +02:00
----
2015-08-10 09:49:04 +02:00
: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>`_
2015-07-06 09:34:22 +02:00
:License: MIT
2016-06-17 20:34:54 +02:00
:Author: Pierre-Francois Carpentier - copyright © 2016
2015-07-06 09:34:22 +02:00
----
2014-06-02 19:46:14 +02:00
2015-07-06 09:34:22 +02:00
****************
Presentation
****************
2015-07-29 09:17:07 +02:00
LdapCherry is a CherryPY application to manage users and groups in multiple directory services.
2015-07-06 09:34:22 +02:00
2015-07-18 00:35:07 +02:00
It's main features are:
2015-07-06 09:34:22 +02:00
2015-07-18 00:35:07 +02:00
* manage multiple directories/databases backends in an unified way
* roles management (as in "groups of groups")
* autofill forms
* password policy
2015-07-21 08:21:09 +02:00
* self modification of some selected fields by normal (non administrator) users
2015-07-18 00:35:07 +02:00
* nice bootstrap interface
2015-07-21 08:21:09 +02:00
* modular through pluggable authentication, password policy and backend modules
2015-07-06 09:34:22 +02:00
2015-07-18 00:35:07 +02:00
LdapCherry is not limited to ldap, it can handle virtually any user backend (ex: SQL database, htpasswd file, etc)
2015-07-21 08:21:09 +02:00
through the proper plugin (provided that it is implemented ^^).
2015-07-06 09:34:22 +02:00
2015-07-18 00:35:07 +02:00
LdapCherry also aims to be as simple as possible to deploy: no crazy dependencies,
few configuration files, extensive debug logs and full documentation.
2015-07-06 09:34:22 +02:00
2016-06-17 20:34:54 +02:00
The default backend plugins permit to manage Ldap and Active Directory.
***************
Screenshots
***************
2015-07-18 00:35:07 +02:00
`Screenshots <http://ldapcherry.readthedocs.org/en/latest/screenshots.html#image1>`_.
2015-07-06 09:34:22 +02:00
2015-11-03 01:44:22 +01:00
***********
Try out
***********
.. sourcecode:: bash
# change the directory where to put the configuration (default: /etc)
$ export SYSCONFDIR=<sys conf dir>
# install ldapcherry
$ pip install ldapcherry
2015-11-03 01:47:47 +01:00
# edit configuration files
2015-11-03 01:44:22 +01:00
$ vi /etc/ldapcherry/ldapcherry.ini
2015-11-03 01:47:47 +01:00
$ vi /etc/ldapcherry/roles.yml
$ vi /etc/ldapcherry/attributes.yml
2015-11-03 01:44:22 +01:00
# launch ldapcherry
$ ldapcherryd -c /etc/ldapcherry/ldapcherry.ini
2015-07-06 09:34:22 +02:00
***********
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>`_
----
2015-11-03 01:59:12 +01:00
.. 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