Installing

A brief description on how to install it

Note that this installation description is for release 1.3.14!

Quick installation

Notes:

Install in a Python virtual environment:

virtualenv -p python2.7 --no-site-packages /opt/web2ldap
/opt/web2ldap/bin/pip2 install --find-links https://www.web2ldap.de/download.html web2ldap

Start simple stand-alone web server by default listening on localhost, port 1760:

/opt/web2ldap/bin/web2ldap 127.0.0.1 1760

See directories etc/apache2/ and etc/uwsgi/ in source distribution for web server integration examples.

Upgrade instructions

If you've customized web2ldap configuration backup your local config changes first:

cp -av /opt/web2ldap/lib/python2.7/site-packages/web2ldapcnf /path/to/backupdir/

Then install the web2ldap upgrade (without necessarily upgrading other modules) like this:

/opt/web2ldap/bin/pip2 install --upgrade --upgrade-strategy only-if-needed --find-links https://www.web2ldap.de/download.html web2ldap

Restore your customized web2ldap configuration e.g. from backup or via config management.

Prerequisites

If you want to create a package of the source distribution for your OS you also need various other OS packages.

PackageRequiredDescription
Python 2.7.0+ (2.7.11+ recommended)
or PyPy 5.0.1 (earlier versions do not work!)
Python 3.x or PyPy3 not supported!
mandatory The programming language needed to run.
PyWebLib 1.3.13 mandatory Module package for web application programming.
ldap0 0.0.60+ mandatory A wrapper module for accessing the OpenLDAP libs from Python and other LDAP-related modules.
OpenLDAP 2.4.11+ client libs (2.4.42+ recommended) mandatory Required to build ldap0 module package.
pyasn1 and pyasn1-modules mandatory Two separate module packages for processing ASN.1 data directly.
ipaddress mandatory Module package for processing IP addresses (netaddr preferred)
PyDNS (2.3.6+ recommended) optional If you want to make use of SRV RR's to automatically locate your LDAP server for a given dc-style DN you have to install this DNS module.
asn1crypto mandatory For displaying short overview of X.509 certificates and CRLs.
paramiko optional For displaying short overview of SSH public keys.
Pillow optional For automatically converting image data to required format (e.g. JPEGImage syntax).
xlwt optional For Excel data export.