Forge Home


Sets up the Abalone web shell. Only tested on CentOS 7.


5,220 latest version

3.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.0.9 (latest)
  • 0.0.8
  • 0.0.7
  • 0.0.6
  • 0.0.5
  • 0.0.4 (deleted)
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Jun 26th 2018
This version is compatible with:
  • Puppet Enterprise >=3.0.0
  • Puppet >=3.0.0 <5.0.0
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'binford2k-abalone', '0.0.9'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install binford2k-abalone --version 0.0.9

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.



binford2k/abalone — version 0.0.9 Jun 26th 2018


A Puppet module for managing Abalone, a simple Sinatra & hterm based web terminal.

Table of Contents

  1. Overview
  2. Usage
    1. Parameters
    2. Custom Parameters
  3. Limitations


Abalone imply exposes a login shell to a web browser. This can be the Unix standard /bin/login using a system user account, a custom command, or an SSH frontend.

See the Abalone project page for more information.


The simplest use case is to just include the class and accept all the defaults:

include abalone


You can customize the configuration by passing in several parameters.

See documentation on the Abalone project page to see what these options do and what values they can take.

  • $port
  • $bind
  • $method
  • $bannerfile
  • $logfile
  • $ssh_host
  • $ssh_cert
  • $ssh_port
  • $ssh_user
  • $command
  • $params (see below)

Custom Parameters

Options for a custom command can be configured by either whitelisting options in an array, or providing a full list of options and values in a hash.

Simple Options

List allowed options in an Array:

class { 'abalone':
  command => '/usr/local/bin/run-container',
  params  => [ 'username', 'image' ],


Customized options

With a Hash you can fully customize the options which may be passed in, including remapping them to command line arguments and filtering accepted values:

class { 'abalone':
  command => '/usr/local/bin/run-container',
  params  => {
    'username' => undef,
    'type'     => ['demo', 'testing'],
    'image'    => {
      'map'    => '--create-image',
      'values' => [ 'ubuntu', 'rhel', '/centos[5,6,7]/' ],



This is still early in development.


I take no liability for the use of this tool.