bitcoind
Version information
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
Add this module to your Puppetfile:
mod 'CraigWatson1987-bitcoind', '3.1.0'
Learn more about managing modules with a PuppetfileDocumentation
puppet-bitcoind
Table of Contents
- Overview - What is the puppet-bitcoind module?
- Module Description - What does the module do?
- Setup - The basics of getting started with puppet-bitcoind
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
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
Setup
Beginning with puppet-bitcoind
To accept default class parameters (correct in most situations):
include bitcoind
Usage
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',
}
Reference
bitcoin.conf
Configuration Parameters
- For detailed explanations of the parameters used to configure the
bitcoind
daemon, see here: https://en.bitcoin.it/wiki/Running_bitcoind
Classes
bitcoind::account
- Creates the system user which runs the
bitcoind
service, and also a group for the user to belong to.
bitcoind::config
- Places the
bitcoin.conf
configuration file and init script
bitcoind::install
- Optionally adds the requested PPA to the system
- Installs the bitcoind package
- Optionally installs the bitcoin-qt package
bitcoind::params
- Disables server if install_gui passed to the module
bitcoind::service
Limitations
Supported Operating Systems
- Ubuntu - 16.06 (Xenial), 14.04 (Trusty) and 12.04 LTS (Precise)
Donations
Donations are welcomed via Bitcoin to 1JJ5STJpzyDbvNiStqsfycCuoNFPgWd2Ho
Development
- Copyright (C) Craig Watson - craig@cwatson.org
- 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
Change Log
3.1.0
2017-09-01 - Feature Release
#### Class: bitcoind
- Added new parameters
ppa_name
andpackage_name
to simplify installation
Class: bitcoind::install
- Using a single
apt::ppa
resource
Class: bitcoind::params
- Refactor to remove references to Bitcoin Classic
3.0.2
2017-04-27 - Bugfix Release
Classes: bitcoind::config
and bitcoind::install
- Fixing another instance of checking against a
not_set
string.
3.0.1
2017-04-27 - Bugfix Release
Class: bitcoind::params
- Fixing check on
$::bitcoind::download_bitcoind_version
to useundef
rather thannot_set
string.
3.0.0
2017-03-10 - Major Version Release
Puppet 3 Support Removed
- This module no longer supports Puppet 3. If you require Puppet 3 functionality, please use version 1.0.4 from the Puppet Forge, or the puppet3 branch in Git.
2.0.2
2016-12-30 - Bugfix Release
Class: bitcoind
- Fixing more stdlib deprecation warnings
2.0.1
### 2016-12-30 - Bug Fix release
Class: bitcoind
- Fixing stdlib deprecation warnings using validate_legacy
2.0.0
2016-12-23 - Major Release to Support Ubuntu 16.04 LTS (Xenial) and HTTP downloads
Class: bitcoind
- Default parameter change - now placing pidfile
- New parameters for
download_bitcoind_version
anddownload_bitcoind_arch
#### Class: bitcoind::params
- Adding logic to handle init script placement for Systemd/Upstart
- Ensures PPAs are
absent
when HTTP downloads are being used
Class: bitcoind::config
- Using
params
variables for init script
Class: bitcoind::install
- Logic to handle download/extraction of gzip downloads
1.6.2
2016-06-03 - Bug Fix Release
### Template: bitcoind.conf.erb
- Adding missing parameter assignment
1.6.1
### 2016-06-03 - Bug Fix Release
### Template: bitcoind.conf.erb
- Correcting typo in template file
### All Classes
- Updating to use explicit top-scope variables
1.6.0
### 2016-06-03 - Feature Update
Class: bitcoind
- New parameter:
peerbloomfilters
(default:true
)
### Class: bitcoind::params
- Handling translation of
bitcoind::peerbloomfilters
param
### Template: bitcoind.conf.erb
- Adding
peerbloomfilters
parameter
1.5.0
2016-03-27 - Feature Update
Class: bitcoind
- New parameter:
maxuploadtarget
(default:'not_set'
)
Template: bitcoind.conf.erb
* Adding new `maxuploadtarget` parameter
1.4.2
2016-03-14 - Documentation update
Readme
- Updated to reflect that Bitcoin Core is the default, not Classic.
- Added section on fork migration.
1.4.1
2016-03-14 - Feature update
Class: bitcoind
- New parameter:
use_bitcoin_classic
(default:false
)
Class: bitcoind::install
- Conditionally adding the Bitcoin Classic PPA
- New
exec
resource to stop thebitcoind
service and purge thebitcoind
package before the new PPA is activated - this allows in-place switching from Core to Classic, or vice versa.
1.3.0
2016-02-16 - Feature update
Class: bitcoind
- New parameter for
dbcache
options
Template: bitcoind.conf.erb
- Adding new
dbcache
parameter, and adding existing (but so far unused!)upnp
parameter
1.2.1
2016-01-14 - Bug fix
Class: bitcoind
- Changed the default value for the
paytxfee
parameter sobitcoind
will start with default values
1.2.0
2016-01-11 - Feature update
Class: bitcoind
- New parameters for
minrelaytxfee
andlimitfreerelay
options
Template: bitcoind.conf.erb
- Adding new parameters into template
1.1.4
2016-01-05 - Bug fix
Template: bitcoind.conf.erb
- Corrected wrong variable for
keypool
parameter
1.1.3
2015-10-11 - Bug fix
Class: bitcoind
- Changing default value for
paytxfee
variable to0.00001
(was0.00
)
Class: bitcoind::install
- Reworked logic to ensure that the PPA has been added and
apt-get update
has been run before installing packages
1.1.2
2015-02-17 - Bug fix
Class: bitcoind
- Added two missing parameters to control the
bitcoind
Service resource - thanks to Nate Riffe for the Pull Request!
1.1.1
2015-01-22 - Bug fix
Template: init.erb
- Moving back up
expect daemon
1.1.0
2014-12-30 - Minor feature update
Class: bitcoind
- Added
bitcoind_nicelevel
parameter (type: int or string, deafult: 0) to be passed to the Upstart init script.
Template: init.erb
- Replaced
expect daemon
withexpect fork
andoom never
withoom score -500
as per this StackExchange answer - Now uses the --nicelevel switch to pass the nice level of the bitcoind process.
1.0.1
### 2014-12-30 - Bug fix
#### Template: bitcoin.conf.erb
- Fixed typo
1.0.0
2014-12-30 - Major improvements and polish
Module dependencies
- Added
puppetlabs/apt
to the dependencies list - this is used in thebitcoind::install
class to add the Bitcoin PPA.
Readme
- Added full readme!
#### Class: bitcoind
- Added
install_gui
parameter (type: boolean, default: false) to enable installation of thebitcoin-qt
GUI interface. - Moving
bitcoind_pidfile
to/var/run
in line with convention for pidfiles. - Added many parameters to better manage
bitcoind
.
Class: bitcoind::params
- Added
datadir
variable, which will either use the configured value from thebitcoind
class, or default to.bitcoin
within the user's home directory.
#### Class: bitcoind::service
- Now using variables from
bitcoind::params
forensure
andenable
.
#### Template: bitcoind.conf.erb
- Using Puppet 3
scope['var']
syntax rather than the olderscope.lookupvar('var')
#### Template: init.erb
- Adding
datadir
to the script options and using Puppet 3 variable syntax
0.0.1
2014-12-29 - Initial Release
- Initial release to the Puppet Forge.
Dependencies
- puppetlabs/apt (>=2.2.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.