Forge Home


Install and configure Hitch TLS proxy


1,346 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.5
  • 0.1.3
  • 0.1.1
  • 0.1.0
released Aug 9th 2021
This version is compatible with:
  • Puppet Enterprise 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, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 8.0.0
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'ssm-hitch', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ssm-hitch
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ssm-hitch --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.



ssm/hitch — version 0.2.0 Aug 9th 2021

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 hitch
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module


This module installs and configures the Hitch TLS proxy, and adds a define to add domains.

Module Description

This module installs the hitch package, and controls the hitch service and the configuration file.

There is a defined type to add domains with key, certificate, as well as an optional certificate chain and dh parameter. The TLS files are concatenated into one PEM file, and added to the configuration file.


What hitch affects

  • Package "hitch"
  • Service "hitch"
  • Directory "/etc/hitch"
  • Configuration file "/etc/hitch/hitch.conf"
  • A PEM file inside /etc/hitch for each domain, with TLS key, certificate, ca certificate chain, and dh parameters.

Setup Requirements

The module requires that the "hitch" package is available in a reachable package repository.

  • If osfamily is RedHat, the module adds the epel-release package with ensure_packages

  • If osfamily is Debian, you are expected to provide a repository containing the "hitch" package.

Beginning with hitch

To start using hitch, you need to include the hitch class, and add at least one hitch::domain.

include ::hitch
hitch::domain { '':
  key_source  => '/tmp/key',
  cert_source => '/tmp/cert.pem',

When configured with this module, hitch will listen by default on all interfaces, port 443/TCP for both IPv4 and IPv6, and forward TCP connections to localhost, port 80.


The module is documented in the file.

When using hitch with varnish or nginx, one can provide information about the connecting client, like the connecting IP Address and port, to varnish by using the PROXY protocol. The backend should be configured with an additional listening port for this protocol.

class { '::hitch':
  write_proxy_v2 => 'on',
  backend        => '[::1]:6086'

In case of varnish, add an extra "-a" parameter for a separate listening port:

-a '[::1]:6086,PROXY'

…to have it listen on port 6086, using the PROXY protocol instead of the HTTP protocol.

For more information about the PROXY protocol, see


You need to define at least one hitch::domain, or the hitch service will not start.


Issues and pull requests welcome.