Forge Home

phpldapadmin

Install and configure phpldapadmin

683,489 downloads

4,915 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.2.0 (latest)
  • 0.1.2
  • 0.1.1 (deleted)
  • 0.1.0
  • 0.0.13
  • 0.0.12
  • 0.0.11
  • 0.0.10
  • 0.0.9
  • 0.0.8
  • 0.0.6 (deleted)
  • 0.0.5 (deleted)
  • 0.0.4 (deleted)
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Jul 22nd 2019
This version is compatible with:
  • Puppet Enterprise 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >=4.10.0 <6.7.0
  • , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'spantree-phpldapadmin', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add spantree-phpldapadmin
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install spantree-phpldapadmin --version 0.2.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

spantree/phpldapadmin — version 0.2.0 Jul 22nd 2019

phpldapadmin

Build Status

Sebastian Otaegui feniix@gmail.com

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with phpldapadmin
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

The phpldapadmin module installs and configures phpldapadmin.

Module Description

This module installs phpldapadmin, and sets up the file '/etc/phpldapadmin/config.php' with provided user/password and hostname.

Setup

What phpldapadmin affects

  • Install the phpldapadmin package.
  • Modify the file /etc/phpldapadmin/config.php with custom values.

Beginning with phpldapadmin

puppet module install spantree-phpldapadmin and follow the instructions specified on the Usage section.

Usage

class { 'phpldapadmin':
  ldap_host      => 'localhost',
  ldap_suffix    => 'dc=domain,dc=tld',
  ldap_bind_id   => 'cn=admin,dc=domain,dc=tld',
  ldap_bind_pass => 'password',
  extraconf      => "
      \$servers->newServer('ldap_pla');
      \$servers->SetValue('server','name','LDAP MyDomain (slave)');
      \$servers->SetValue('server','host','ldap2.mydomain.org');
      \$servers->SetValue('server','port','389');
      \$servers->SetValue('server','base',array('dc=mydomain,dc=org','cn=config'));
      \$servers->SetValue('login','auth_type','session');
      \$servers->SetValue('login','bind_id','cn=admin,dc=mydomain,dc=org');
      \$servers->SetValue('server','tls',false);
      \$servers->SetValue('appearance','password_hash','crypt');
      \$servers->SetValue('server','read_only',false);
      \$servers->SetValue('appearance','show_create',true);
      \$servers->SetValue('auto_number','enable',false);"
}

or in hiera

---
phpldapadmin::extraconf : |
  $servers->newServer('ldap_pla');
  $servers->SetValue('server','name','LDAP MyDomain (slave)');
  $servers->SetValue('server','host','ldap2.mydomain.org');
  $servers->SetValue('server','port','389');
  $servers->SetValue('server','base',array('dc=mydomain,dc=org','cn=config'));
  $servers->SetValue('login','auth_type','session');
  $servers->SetValue('login','bind_id','cn=admin,dc=mydomain,dc=org');
  $servers->SetValue('server','tls',false);
  $servers->SetValue('appearance','password_hash','crypt');
  $servers->SetValue('server','read_only',false);
  $servers->SetValue('appearance','show_create',true);
  $servers->SetValue('auto_number','enable',false);

To use the module with CentOS you need to add the EPEL repository, one way to do that is to use the module stahnma/epel.

Reference

Public classes

Private classes

  • phpldapadmin::config: writes the file /etc/phpldapadmin/config.php with proper values.

  • phpldapadmin::package: installs the package using the package manager.

###Class: phpldapadmin

This class is provided to do the basic setup tasks required for using phpldapadmin.

At the moment if does not take care of setting up a web server to serve the web pages.

####ldap_host

Parameter that controls the ldap the phpldapadmin needs to connect.

ldap_host can either be an ipv4 address or a hostname.

####ldap_suffix

Parameter that controls the top level suffix for the ldap.

ldap_suffix must be a string with the appropriate suffix.

####ldap_bind_id

Parameter that controls the id used to bind and manage the ldap.

ldap_bind_id must be a user that has administrative access to the ldap server.

####ldap_bind_pass

Optional parameter that controls the password of the user specified in the ldap_bind_id parameter.

If not specified, you wil be prompted for the password.

Limitations

This module has been tested on Ubuntu 14.04 and CentOS 6.5. It should also work on Debian/Ubuntu 12.04, RedHat/CentOS 7 and FreeBSD 10+.

At the moment it does not configure the phpldapadmin app with SASL.

Development

Use your favorite text editor (mine is vim) and run bundle exec rake test to test, don't forget to bundle install first.

Release Notes/Contributors/Etc

To do