shellinabox

Tested with Travis CI

Table of Contents

1. Description
2. Setup - The basics of getting started with shellinabox
   • Setup requirements
   • Beginning with shellinabox
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

This module installs and manages ShellInABox.

RHEL/CentOS is supported using Puppet 4.9.0 or later.

Setup

Setup Requirements

On RHEL/CentOS platforms you will need to have access to the EPEL repository by using stahnma/epel or by other means.

Beginning with shellinabox

In the very simplest case, you can just include the following:

include ::shellinabox

Usage

To run an SSH instance listening on localhost-only suitable for using with a reverse proxy:

class { '::shellinabox':
  disable_ssl      => true,
  disable_ssl_menu => true,
  localhost_only   => true,
  services         => {
    '/' => 'SSH',
  },
}

Reference

The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-shellinabox/.

Limitations

This module has been built on and tested against Puppet 4.9.0 and higher.

The module has been tested on:

• CentOS/Red Hat Enterprise Linux 6/7

Development

The module has both rspec-puppet and beaker-rspec tests. Run them with:

$ bundle exec rake test
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:<nodeset>

Please log issues or pull requests at github.