Forge Home

cntlm

Installs and configures cntlm, the NTLM authenticating HTTP proxy.

7,371 downloads

5,489 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

  • 1.0.0 (latest)
  • 0.1.1
  • 0.1.0
released Jun 16th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'jacobhenner-cntlm', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jacobhenner-cntlm
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jacobhenner-cntlm --version 1.0.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

jacobhenner/cntlm — version 1.0.0 Jun 16th 2018

cntlm

Table of Contents

  1. Description
  2. Setup - The basics of getting started with cntlm
  3. Reference - An under-the-hood peek at what the module is doing and how
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

The cntlm module installs, configures, and manages the cntlm service across a range of Linux distributions.

Setup

Setup Requirements

If you intend to use this module to install cntlm, please ensure any optional repositories containing cntlm have been enabled. For example, on Red Hat and its derivatives EPEL must be enabled.

Beginning with cntlm

To install and configure cntlm with some basic settings:

class { 'cntlm':
  cntlm_username => 'test_user',
  cntlm_domain   => 'test_domain',
  cntlm_password => 'test_password',
  cntlm_proxy    => ['localhost:8080'],
}

All cntlm settings are configurable via cntlm_<lowercase_param_name>.

Reference

Classes

Public classes

  • cntlm: Main class, contains all other classes.

Private classes

  • cntlm::install: Handles the packages.
  • cntlm::config: Handles the configuration file.
  • cntlm::service: Handles the service.

Parameters

For more information about this module's parameters, generate the puppet strings documentation using puppet strings and view doc/puppet_classes/cntlm.html

Limitations

This module has only been tested on CentOS 7, Debian Stretch and Ubuntu Xenial. Support for other platforms is possible by overriding default configuration values.

Pre-hashed passwords must be supplied to the module's hashed password parameters. The module does not perform automatic hashing of cleartext passwords.

Development

Contributions are encouraged, please open a pull request for all proposed changes, and ensure Puppet best practices are maintained.