1
0
Fork 0
mirror of https://github.com/kakwa/ldapcherry synced 2025-07-04 20:37:48 +02:00
ldapcherry/docs/install.rst

70 lines
1.9 KiB
ReStructuredText

Install
=======
Using pip
---------
Install the dependencies from the operating system's repos, and then install ldapcherry using `pip`:
.. sourcecode:: bash
# RHEL/CentOS
$ sudo yum install epel-release && sudo yum install python-pip python-devel gcc openldap-devel
# Debian/Ubuntu
$ sudo apt install python-dev python-pip libldap2-dev libsasl2-dev libssl-dev
$ pip install ldapcherry
From the sources
----------------
Install the dependencies from the operating system's repos:
.. sourcecode:: bash
# RHEL/CentOS
$ sudo yum install epel-release && sudo yum install python36-pip python36-devel python36-PyYAML gcc openldap-devel
# Debian/Ubuntu
$ sudo apt install python-dev python-pip libldap2-dev libsasl2-dev libssl-dev
Download the latest release from `GitHub <https://github.com/kakwa/ldapcherry/releases>`_.
.. sourcecode:: bash
$ tar -xf ldapcherry*.tar.gz
$ cd ldapcherry*
$ python setup.py install
Alternatively, you can install from git:
.. sourcecode:: bash
$ git clone https://github.com/kakwa/ldapcherry
$ cd ldapcherry
$ python setup.py install
Installed files
---------------
ldapCherry install directories are:
* **/etc/ldapcherry/** (configuration)
* **dist-package** or **site-packages** of your distribution (LdapCherry modules)
* **/usr/share/ldapcherry/** (static content (css, js, images...) and templates)
These directories can be changed by exporting the following variables before launching the install command:
.. sourcecode:: bash
# optional, default sys.prefix + 'share' (/usr/share/ on most Linux)
$ export DATAROOTDIR=/usr/local/share/
# optional, default /etc/
$ export SYSCONFDIR=/usr/local/etc/
.. note:: if --root is passed, the install prefix is honored for these directories
.. warning:: If you change these directories, **templates.dir** and **tools.staticdir.dir** in *ldapcherry.ini* need to be modified accordingly.