voxpupuli/puppet-etherpad

Name: puppet-etherpad

Owner: Vox Pupuli

Description: Puppet Module to install and configure etherpad

Created: 2015-12-15 13:51:55.0

Updated: 2018-05-23 05:59:32.0

Pushed: 2018-05-23 05:59:31.0

Homepage: https://forge.puppet.com/puppet/etherpad

Size: 127

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Etherpad module for Puppet

Table of Contents

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

Overview

This module installs and configures etherpad(-lite). It's inspired by existing etherpad modules on the Forge, but attempts to “do it right?“.

Setup

What etherpad affects

• This module depends on puppet-nodejs
• It also depends on puppetlabs-vcsrepo, and hence git
• It will setup a service using the system's preferred init
• When running installDeps.sh, this module requires all the usual build tools, development packages and headers as any other (complex) npm install

Setup Requirements

This module requires a database. With no database available, it will use DirtyDB as fallback. This is not intended for production use.

For a migration from DirtyDB, please consult this blog post

Beginning with etherpad

Before to installation, a target database should exist. Please consult the documentation of puppetlabs-postgresql, or puppetlabs-mysql for how to create those.

Usage

The basic usage is:

ude ::etherpad

note that this will use the local DirtyDB and is not recommended beyond basic testing. For production setups, use:

s { ::etherpad:
sure            => 'present',
tabase_type     => 'mysql',
tabase_name     => 'etherpad',
tabase_user     => 'etherpad',
tabase_password => '37h3rp4d',
ers             => {
admin => {
  password => 's3cr3t',
  is_admin => true,
},
user  => {
  password => 'secret',
  is_admin => false,
},

Reference

etherpad

The etherpad module installs and configures etherpad. This class is the entry point for the module and the configuration point.

ensure

Ensure the presence (present, latest) or absence (absent) of etherpad. This can also be set to a specific version (or SHA1 hash). By default, we install from the branch develop, in order to cater for newer versions of Nodejs. absent will completely remove the software, its dependencies, and the users and groups.

|Type|Default| |—-|——-| | String | present |

service_name

Name under which the service will be known.

|Type |Default | |—–|——–| | String | etherpad |

service_ensure

Ensure whether the service is running or stopped. If you're passing absent to ensure, please also pass stopped to service_ensure.

|Type |Default | |—–|——–| | Enum['running', 'stopped'] | running |

service_provider

Which service provider to use. By default this is taken from stdlib's $::service_provider fact. Currently only upstart and systemd are supported!

|Type |Default | |—–|——–| | Optional[String] | $::service_provider |

manage_user

Whether to manage the user & group under which etherpad will be running.

|Type |Default | |—–|——–| |Boolean|true|

manage_abiword

Whether to manage the dependency of the abiword package.

|Type |Default | |—–|——–| |Boolean|false|

abiword_path

Absolute Path to the abiword binary.

|Type |Default | |—–|——–| |String|/usr/bin/abiword|

manage_tidy

Whether to manage the dependency of the tidy package.

|Type |Default | |—–|——–| |Boolean|false|

abiword_path

Absolute Path to the abiword binary.

|Type |Default | |—–|——–| |String|/usr/bin/abiword|

user & group

The user and group under which etherpad will be running.

|Type |Default | |—–|——–| |String|etherpad|

root_dir

Absolute Path of the etherpad installation.

|Type |Default | |—–|——–| |String|/opt/etherpad|

source

URL to the git source of etherpad.

|Type |Default | |—–|——–| |String|'https://github.com/ether/etherpad-lite.git'|

database_type

The type of database that etherpad should use. In case of mysql or postgres, you'll also have to set the options below.

|Type |Default | |—–|——–| |Enum[dirty, mysql, sqlite, postgres]|dirty|

database_host

Host on which the database is running.

|Type |Default | |—–|——–| |String|localhost|

database_user

User (or role) to use, when connecting to the database.

|Type |Default | |—–|——–| |String|etherpad|

database_name

Name of database to connect to.

|Type |Default | |—–|——–| |String|etherpad|

database_password

Password to use when connecting to database.

|Type |Default | |—–|——–| |String|etherpad|

ip

IP on which etherpad will be listening. The default, undef, turns into null, and hence NodeJS' default of “all interfaces”.

|Type |Default | |—–|——–| |String|undef|

port

Port on which etherpad will be listening.

|Type |Default | |—–|——–| |Integer|9001|

trust_proxy

This value should be set if etherpad is running behind a proxy.

|Type |Default | |—–|——–| |Boolean|false|

max_age

How long clients may use served JavaScript code (in seconds).

|Type |Default | |—–|——–| |Integer|21600|

minify

Whether to minify the delivered JavaScript and CSS.

|Type |Default | |—–|——–| |Boolean|true|

require_session

Users must have a session to access pads. This effectively allows only group pads to be accessed.

|Type |Default | |—–|——–| |Boolean|false|

edit_only

Users may edit pads but not create new ones. Pad creation is only via the API. This applies both to group pads and regular pads.

|Type |Default | |—–|——–| |Boolean|false|

require_authentication

This setting is used if you require authentication of all users.

Note: /admin always requires authentication.

|Type |Default | |—–|——–| |Boolean|false|

require_authorization

Require authorization by a module, or a user with is_admin set, see below.

|Type |Default | |—–|——–| |Boolean|false|

button_link

The setting should be used to set ep_button_link module params as described at https://github.com/JohnMcLear/ep_button_link

|Type |Default | |—–|——–| |Optional[Hash]|undef|

ldapauth

The setting should be used to set ep_ldapauth module params as described in https://github.com/tykeal/ep_ldapauth If both 'users' and 'ldapauth' are set only the latter one will be put into settings.json.

|Type |Default | |—–|——–| |Optional[Hash]|undef|

pad_title

Name of your instance

|Type |Default | |—–|——–| |Optional[String]|undef|

default_pad_text

The default text of a pad.

|Type |Default | |—–|——–| |String|Welcome to etherpad!|

logconfig_file

Enable/disable logging to a file.

|Type |Default | |—–|——–| |Boolean|false|

logconfig_file_filename

Specify the file to log to, if logconfig_file is enabled.

|Type |Default | |—–|——–| |Optional[String]|undef|

logconfig_file_max_log_size

The maximum logfile size (megabytes) before rotating the log file.

|Type |Default | |—–|——–| |Optional[Integer]|undef|

logconfig_file_backups

The number of logfiles to keep after rotation.

|Type |Default | |—–|——–| |Optional[Integer]|undef|

logconfig_file_category

Only log a specific category.

|Type |Default | |—–|——–| |Optional[String]|undef|

users

Configure users in settings.json. If both 'users' and 'ldapauth' are set only the latter one will be put into settings.json.

|Type |Default | |—–|——–| |Optional[Hash]|undef|

Limitations

Currently, only upstart and systemd are supported as Service providers. More support is highly welcomed.

Development

Please see CONTRIBUTING.md for how to contribute patches!