Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

ssp

Setup Self Service Password HTTPS (SSP)
Project URLRSS FeedReport issues

655 downloads

205 latest version

4.7 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

  • 1.2.0 (latest)
  • 1.1.1
  • 1.0.1
  • 1.0.0
released Aug 14th 2023
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'markt-ssp', '1.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add markt-ssp
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install markt-ssp --version 1.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

markt/ssp — version 1.2.0 Aug 14th 2023

puppet-ssp

Table of Contents

  1. Description
  2. Requirements
  3. Usage
  4. Reference
  5. Documentation
  6. Development
  7. License

Description

This is a puppet module to install and manage Self Service Password. It is flexible to change and enable default Self Service Password functions for your location.

Requirements

This module should work with all officially supported versions of Self Service Password. The focus of this module is Self Service Password, so you should ensure that all additional components are available and ready to use:

  • A webservice like Nginx or Apache puppetlabs/apache is recommended.
  • A supported version of PHP (PHP-FPM is strongly recommended). The module is capable of providing a default installation of PHP, if the optional soft dependency puppet/php is available.

Usage

Basic usage

One parameter is required to setup Self Service Password:

class { 'ssp':
  version => '1.5.2'
}

If you want to change the smarty version while installation process, you have to change the parameter in hiera OS-familys, like Debian-family.yaml

class { 'ssp':
  smarty_package_name => 'smarty3'

If you want to change the default folder path of smarty, you have to change the one parameter in init.pp

class { 'ssp':
  smarty_path => '/usr/share/php/Smarty/Smarty.class.php'
}

The folder of the Self Service Password installation is derived from two parameters: $installroot and $symlink_name. Using different folders is simple:

class { 'ssp':
  installroot  => '/opt',
  symlink_name => 'ssp',
}

In this example the Self Service Password installation will live in /opt/self-service-password, and this folder should be used as DocumentRoot for the webservice (and/or PHP-FPM).

Configure Self Service Password

Please note, never change the default config.inc.php. It is not recommended. All entries in config can be changed in Self Service Password.

For example:

class { 'ssp':
...
  config         => {
    ldap_url       => 'ldap://localhost',
    ldap_binddn    => 'cn=binduser',
    ldap_base      => 'dc=exaple,dc=com',
    pwd_min_length => 20,
    shadow_options => {
      update_shadowLastChange => true,
      shadow_expire_days      => -1,
    },
  },
}

Directory structure

When using the module with default options... 

class { 'ssp':
  installroot  => '/opt',
  symlink_name => 'ssp',
  version      => '1.5.2',
}

...the directory structure will look like this:

/
|-- opt/
|   |-- ssp@                                  # symlink to the current install dir (ssp-1.5.2)
|   |-- self-service-password                 # default install dir 
|   |-- self-service-password-1.5.2           # install dir for the current version
|   |   |-- conf/                             # default configuration folder
|   |       |-- config.inc.php                # default configuration for SSP (do not change, recommended)
|   |       |-- config.inc.local.php          # local config file to change settings in/for config.inc.php

Reference

Classes and parameters are documented in REFERENCE.md.

Documentation

You can read more settings in the Self Service Password Documentation

Development

Contributing

Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.

License

Copyright 2023 Daniel Renz