Forge Home


Manage installation and configuration of the Bitcoin daemon.


6,552 latest version

4.3 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.1.0 (latest)
  • 3.0.2
  • 3.0.1
  • 3.0.0
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.6.2
  • 1.6.1
  • 1.6.0
  • 1.5.0
  • 1.4.2
  • 1.4.1
  • 1.4.0 (deleted)
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.1.4
  • 1.1.3
  • 1.1.2
  • 1.1.1
  • 1.1.0
  • 1.0.1
  • 1.0.0
  • 0.0.1
released Sep 1st 2017
This version is compatible with:
  • Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=4.6.1 <5.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'CraigWatson1987-bitcoind', '3.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add CraigWatson1987-bitcoind
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install CraigWatson1987-bitcoind --version 3.1.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.



CraigWatson1987/bitcoind — version 3.1.0 Sep 1st 2017


Build Status Puppet Forge

Table of Contents

  1. Overview - What is the puppet-bitcoind module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with puppet-bitcoind
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module


This Puppet module installs and configures the bitcoind daemon, and can optionally install the bitcoin-qt GUI - though this will disable the service/daemon.

Puppet 3 Support

Please note that the master branch of this module does not support Puppet 3!

On 31st December 2016, support for Puppet 3.x was withdrawn. As such, this module no longer supports Puppet 3, and is actively being migrated to Puppet 4 syntax.

If you require Puppet 3 compatibility, please use version 2.0.2 from the Puppet Forge, or the puppet3 branch in Git.

Using Alternative Repositories

This module can handle the installation of the Bitcoin daemon from any Ubuntu PPA repository. To use a third-party repository (e.g. Bitcoin Classic or UASF), simply set the ppa_name and package_name parameters - the default is to install Bitcoin Core from the official PPA.

Module Description

  • Adds the requested PPA (see above) and installs bitcoind
  • Creates a (configurable) system user and group
  • Places an Upstart init script (Systemd in Ubuntu 16.04 and later)
  • Configures the bitcoin.conf configuration file
  • Enables and starts the bitcoind daemon/service


Beginning with puppet-bitcoind

To accept default class parameters (correct in most situations):

include bitcoind


To use the an alternative Ubuntu PPA repository, specify an RPC user/password and disable wallet functionality:

class { 'bitcoind':
  disablewallet => true,
  rpcallowip    => ['123.456.789.100'],
  rpcuser       => 'oliver'
  rpcpassword   => 'youvegottopickapocketortwo',
  ppa_name      => 'luke-jr/bitcoin-core-bip148-unofficial-builds',
  package_name  => 'bitcoin',


bitcoin.conf Configuration Parameters



  • Creates the system user which runs the bitcoind service, and also a group for the user to belong to.


  • Places the bitcoin.conf configuration file and init script


  • Optionally adds the requested PPA to the system
  • Installs the bitcoind package
  • Optionally installs the bitcoin-qt package


  • Disables server if install_gui passed to the module



Supported Operating Systems

  • Ubuntu - 16.06 (Xenial), 14.04 (Trusty) and 12.04 LTS (Precise)


Donations are welcomed via Bitcoin to 1JJ5STJpzyDbvNiStqsfycCuoNFPgWd2Ho


  • Copyright (C) Craig Watson -
  • Distributed under the terms of the Apache License v2.0 - see LICENSE file for details.
  • Further contributions and testing reports are extremely welcome - please submit a pull request or issue on GitHub