cntlm
Version information
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
Add this module to your Puppetfile:
mod 'jacobhenner-cntlm', '1.0.0'
Learn more about managing modules with a PuppetfileDocumentation
cntlm
Table of Contents
- Description
- Setup - The basics of getting started with cntlm
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- 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.
Changelog
All notable changes to this project will be documented in this file.
Release 0.1.1
Summary
Revise module and documentation to use resource-like class declaration.
Changed
- manifests/init.pp updated to use resource-like class declaration in docstrings.
- examples/init.pp updated to use resource-like class declaration.
- README updated to include resource-like class declaration examples.
- Documentation directory changed to doc/ (from docs/)
- CHANGELOG format changed.
Release 0.1.0
Summary
Initial release
Known issues
- Validation is not currently performed on configuration parameters.
- Unit tests are not yet implemented. The pdk defaults are still included.