Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 6.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-mumble', '2.1.1'
Learn more about managing modules with a PuppetfileDocumentation
Mumble module for Puppet
Table of Contents
- Overview
- Module Description
- Setup - The basics of getting started with puppet-mumble
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This module installs the Mumble VoIP server, murmurd.
It is in beta development and tested on Ubuntu 12.04 and 14.04.
Module Description
This module is intended for Ubuntu. If $ppa
is true, it adds either
the snapshot or release (depending on $snapshot
) Mumble PPA, then
installs mumble-server, configures it through a template, and starts
the service.
Get in touch
- IRC: #voxpupuli on irc.freenode.net (Freenode WebChat)
- Mailinglist: voxpupuli@groups.io (groups.io Webinterface)
Setup
What puppet-mumble affects
- Packages
mumble-server
libicu-dev
if$libicu_dev
(bugfix)
- PPAs
ppa:mumble/release
ppa:mumble/snapshot
- Services
mumble-server
- Files
/etc/mumble-server.ini
- User
mumble-server
- Group
mumble-server
Beginning with puppet-mumble
The simplest use of this module is:
include mumble
Usage
Generated puppet strings documentation with examples is available from https://voxpupuli.org/puppet-mumble/
It's also included in the docs/ folder as simple html pages.
This module has one class, mumble
, with the following
parameters:
$autostart = true, # Start server at boot
$ppa = false, # Install the PPA
$snapshot = false, # Use snapshot over release PPA
$server_password = '', # Supervisor account password
# The following parameters affect mumble-server.ini through a template
# For more info, see http://mumble.sourceforge.net/Murmur.ini
$register_name = 'Mumble Server',
$password = undef, # General entrance password
$port = 64738,
$host = '',
$user = 'mumble-server',
$group = 'mumble-server',
$bandwidth = 72000,
$users = 100,
$text_length_limit = 5000,
$autoban_attempts = 10,
$autoban_time_frame = 120,
$autoban_time = 300,
$database_path = '/var/lib/mumble-server/mumble-server.sqlite',
$log_path = '/var/log/mumble-server/mumble-server.log',
$allow_html = true,
$log_days = 31,
$ssl_cert = '',
$ssl_key = '',
$welcome_text = '<br />Welcome to this server running <b>Murmur</b>.<br />Enjoy your stay!<br />',
Note that the mumble-server package by default sets up a user and group named 'mumble-server', and so will be created additionally if the user and group are changed here.
More information about the configuraiton file's settings can be found in the Wiki.
The snapshot
parameter enables the use of the snapshot PPA, which as
of this writing, seems to fix the bug where libicui-dev was needed but
not a dependency.
The server_password
parameter sets the supervisor account's password
by executing murmurd -supw password
, it is not a template
configuration, and thus can be set manually as well.
Limitations
This module currently only supports Ubuntu. It is working on my Vagrant box, Ubuntu 12.04.4 LTS with Puppet 3.4.1, and as such it's development is on hold.
If Mumble ever runs without being given an SSL certificate and key, then it will auto-generate its own. If later given a custom certificate and key, the Mumble service must be stopped, and then manually run with the option to wipe the keys from its internal configuration database.
service mumble-server stop
murmurd -wipessl
pkill murmurd
service mumble-server start
Please note that on Debian / Ubuntu, you may want to change
USER=mumble-server
to USER=root
in /etc/init.d/mumber-server
so
that root owned keys can be read by Mumble on startup, as per this
bug. The
Mumble daemon automatically drops privileges itself.
Development
Fork on GitHub, make a Pull Request.
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v2.1.1 (2018-09-06)
Fixed bugs:
- Starts service on every provision #1
Merged pull requests:
- allow puppetlabs/apt 6.x #43 (bastelfreak)
- Remove docker nodesets #37 (bastelfreak)
- drop EOL OSs; fix puppet version range #35 (bastelfreak)
- regenerate puppet-strings docs #32 (bastelfreak)
v2.1.0 (2017-11-13)
Merged pull requests:
- release 2.1.0 #30 (bastelfreak)
- modulesync 0.21.3, bump to minimal recommended puppet version #26 (bastelfreak)
v2.0.0 (2017-05-14)
Merged pull requests:
- Fix license in metadata.json #24 (alexjfisher)
v1.1.0 (2017-02-11)
Merged pull requests:
- modulesync 0.16.7 #17 (bastelfreak)
- Set min version_requirement for Puppet + apt #16 (juniorsysadmin)
- modulesync 0.16.6 #15 (bastelfreak)
- modulesync 0.16.4 #14 (bastelfreak)
- modulesync 0.16.3 #13 (bastelfreak)
- modulesync 0.15.0 #12 (bastelfreak)
- Add missing badges #11 (dhoppe)
- Update based on voxpupuli/modulesync_config 0.14.1 #10 (dhoppe)
- modulesync 0.13.0 #9 (bbriggs)
- modulesync 0.12.9 #8 (bbriggs)
- modulesync 0.12.5 #7 (bastelfreak)
v1.0.0 (2016-08-18)
Merged pull requests:
- modulesync 0.12.1 & Release 1.0.0 #6 (bastelfreak)
- modulesync 0.11.1 #5 (bastelfreak)
- Added support to install a specific version of mumble #4 (x3dfxjunkie)
- added register_name variable #2 (webberist)
0.0.3 (2014-05-09)
0.0.2 (2014-01-19)
0.0.1 (2014-01-16)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/apt (>= 2.1.0 < 7.0.0)
The MIT License (MIT) Copyright (c) 2014 Andrew Schwartzmeyer Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.