etherpad

Install and configure etherpad-lite

ULHPC DevOps Team

ULHPC

6,855 downloads

6,855 latest version

4.6 quality score

Version information

  • 0.1.2 (latest)
released May 13th 2015
This version is compatible with:
  • Debian

Start using this module

Documentation

ULHPC/etherpad — version 0.1.2 May 13th 2015

-- mode: markdown; mode: visual-line; --

Etherpad Puppet Module

Puppet Forge License Supported Platforms

Install and configure etherpad-lite

  Copyright (c) 2015 UL HPC Management Team <hpc-sysadmins@uni.lu>
  

Synopsis

Install and configure etherpad-lite.

This module implements the following elements:

  • Puppet classes:

    • etherpad
    • etherpad::common
    • etherpad::common::debian
    • etherpad::params
  • Puppet definitions:

All these components are configured through a set of variables you will find in manifests/params.pp.

Note: the various operations that can be conducted from this repository are piloted from a Rakefile and assumes you have a running Ruby installation. See doc/contributing.md for more details on the steps you shall follow to have this Rakefile working properly.

Dependencies

See metadata.json. In particular, this module depends on

Overview and Usage

Class etherpad

This is the main class defined in this module. It accepts the following parameters:

  • $ensure: default to 'present', can be 'absent'

Use it as follows:

class { 'etherpad':
    pad_title      => 'Etherpad-lite @ uni.lu',
    ip             => '0.0.0.0',
    dbtype         => 'dirty',
    session_key    => 'F98Sjdosz1',
    abiword        => 'present',
    admin_password => 'jhtyd64s8x'
}

Or with a MySQL database:

class { 'etherpad':
    pad_title      => 'Etherpad-lite @ csc.uni.lu',
    ip             => '127.0.0.1',
    dbtype         => 'mysql',
    session_key    => 'F98Sjdosz1',
    mysql_user     => 'etherpad',
    mysql_host     => 'localhost',
    mysql_password => '*mysqlPassword*',
    mysql_database => 'etherpad',
    abiword        => 'present',
    admin_password => 'jhtyd64s8x'
}

See also tests/init.pp

Class etherpad::common

See tests/common.pp

Class etherpad::common::debian

See tests/common/debian.pp

Class etherpad::params

See tests/params.pp

Librarian-Puppet / R10K Setup

You can of course configure the etherpad module in your Puppetfile to make it available with Librarian puppet or r10k by adding the following entry:

 # Modules from the Puppet Forge
 mod "ULHPC-etherpad"

or, if you prefer to work on the git version:

 mod "ULHPC-etherpad", 
     :git => https://github.com/ULHPC/puppet-etherpad,
     :ref => production 

Issues / Feature request

You can submit bug / issues / feature request using the ULHPC-etherpad Puppet Module Tracker.

Developments / Contributing to the code

If you want to contribute to the code, you shall be aware of the way this module is organized. These elements are detailed on doc/contributing.md

You are more than welcome to contribute to its development by sending a pull request.

Puppet modules tests within a Vagrant box

The best way to test this module in a non-intrusive way is to rely on Vagrant. The Vagrantfile at the root of the repository pilot the provisioning various vagrant boxes available on Vagrant cloud you can use to test this module.

See doc/vagrant.md for more details.