Forge Home


A module for appcanary


5,744 latest version

1.9 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.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Jun 14th 2017

Start using this module

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

Add this module to your Puppetfile:

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

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

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

Tags: security


appcanary/appcanary — version 0.2.0 Jun 14th 2017


Table of Contents

  1. Description
  2. Setup - The basics of getting started with Appcanary
  3. Usage
  4. Reference
  5. Limitations
  6. Development


Appcanary is a security service that monitors your infrastructure for security vulnerabilities. This module will manage the agent on your hosts.

You'll need to provide the module with your API key and a list of paths to monitor.


Setup Requirements

The Appcanary agent package is hosted on, so be sure to grab computology/packagecloud from the Forge. You can just add the following to your Puppetfile:

mod 'computology/packagecloud'

Beginning with Appcanary

You'll need your API key from With that in hand this will get you started:

class { '::appcanary':
  api_key: yourapikeyhere


To have Appcanary monitor the gems in your Ruby application for vulnerabilities you need to provide a path to your Gemfile.lock:

class { '::appcanary':
  api_key: yourapikeyhere
    - /path/to/your/Gemfile.lock
    - /a/different/Gemfile.lock



Public Classes

  • appcanary: Main class, includes all other classes.

Private Classes

  • appcanary::prereq: Installs the repository where Appcanary resides
  • appcanary::install: Installs Appcanary
  • appcanary::config: Configures Appcanary
  • appcanary::service: Ensures Appcanary runs


The following parameters are available in the ::appcanary class:

####api_key Specifies your API key. Get yours from

####paths Specifies the paths to your Gemfile.locks


Only tested on Ubuntu Trusty so far. Should work on any platform supported by the module and by Appcanary itself.


Contributions are welcome anytime. Open issues or send pull requests.