Forge Home


Setup Patchwork


148 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

  • 3.0.0 (latest)
  • 2.2.0
  • 2.1.1
  • 2.1.0
  • 2.0.0
  • 1.0.1
released Dec 13th 2023
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, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 8.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetfinland-patchwork', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetfinland-patchwork
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetfinland-patchwork --version 3.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.



puppetfinland/patchwork — version 3.0.0 Dec 13th 2023


A Puppet module for installing and configuring Patchwork. By default this module configures all components (patchwork, getmail, nginx, postgresql, uwsgi) required for Patchwork, but each of those can be managed outside of the module as well.


If you use this module to configure all aspects of Patchwork you need all the modules defined in Puppetfile.

Module usage

Example usage from vagrant/patchwork.pp:

$admins                   = { 'admin' => 'admin@vagrant.example.lan' }
$allowed_hosts            = '*'
$default_from_email       = 'patchwork@vagrant.example.lan'
$db_password              = 'vagrant'
$imap_password            = 'vagrant'
$imap_port                = 993
$imap_server              = 'localhost'
$imap_username            = 'vagrant'
$mailboxes                = 'Inbox'
$revision                 = 'v3.0.5'
$secret_key               = 'Kp|:Ych*AF^WIg4*<lpb}6T.P4etTI2E)qs.g4uqaSE0V*TPWs'
$server_name              = 'patchwork.vagrant.example.lan'
$admin_allow_address_ipv4 = ''
$rest_allow_address_ipv4  = ''
$ssl                      = true
$ssl_cert                 = '/etc/ssl/certs/ssl-cert-snakeoil.pem'
$ssl_key                  = '/etc/ssl/private/ssl-cert-snakeoil.key'

class { '::patchwork':
  manage_datasource        => true,
  manage_nginx             => true,
  revision                 => $revision,
  secret_key               => $secret_key,
  allowed_hosts            => $allowed_hosts,
  enable_rest_api          => true,
  default_from_email       => $default_from_email,
  db_password              => $db_password,
  admins                   => $admins,
  server_name              => $server_name,
  imap_server              => $imap_server,
  imap_port                => $imap_port,
  imap_username            => $imap_username,
  imap_password            => $imap_password,
  mailboxes                => $mailboxes,
  admin_allow_address_ipv4 => $admin_allow_address_ipv4,
  rest_allow_address_ipv4  => $rest_allow_address_ipv4,
  ssl                      => $ssl,
  ssl_cert                 => $ssl_cert,
  ssl_key                  => $ssl_key,

For details see manifests/init.pp.