xref: /netbsd-src/external/bsd/openldap/dist/contrib/slapd-modules/ppm/INSTALL.md (revision 122b5006ee1bd67145794b4cde92f4fe4781a5ec)
1INSTALLATION
2============
3
4Dependencies
5------------------
6ppm is provided along with OpenLDAP sources. By default, it is available into contrib/slapd-modules.
7 - make sure both OpenLDAP sources and ppm are available for building.
8 - install cracklib development files if you want to test passwords against cracklib
9
10
11Build
12-----
13Enter contrib/slapd-modules/ppm directory
14
15You can optionally customize some variables if you don't want the default ones:
16- prefix: prefix of the path where ppm is to be installed (defaults to /usr/local)
17- ldap_subdir: OpenLDAP specific subdirectory for modules and configurations (defaults to  openldap )
18- moduledir: where the ppm module is to be deployed (defaults to $prefix/$libexecdir/$ldap_subdir)
19- etcdir: used to compose default sysconfdir location (defaults to $prefix/etc)
20- sysconfdir: where the ppm example policy is to be deployed (defaults to $prefix/$etcdir/$ldap_subdir)
21- LDAP_SRC: path to OpenLDAP source directory
22- Options in OPTS variable:
23    CONFIG_FILE: (DEPRECATED) path to a ppm configuration file (see PPM_READ_FILE in ppm.h)
24        note: ppm configuration now lies into pwdCheckModuleArg password policy attribute
25              provided example file is only helpful as an example or for testing
26    CRACKLIB: if defined, link against cracklib
27    DEBUG: If defined, ppm logs its actions with syslog
28
29
30To build ppm, simply run these commands:
31(based upon the default prefix /usr/local of OpenLDAP)
32
33```
34make clean
35make
36make test
37make install
38```
39
40Here is an illustrative example showing how to overload some options:
41
42```
43make clean
44make LDAP_SRC=../../.. prefix=/usr/local libdir=/usr/local/lib
45make test LDAP_SRC=../../..
46make install prefix=/usr/local libdir=/usr/local/lib
47```
48
49