Version information
Start using this module
Add this module to your Puppetfile:
mod 'andschwa-mumble', '0.0.3'
Learn more about managing modules with a PuppetfileDocumentation
andschwa-mumble
Table of Contents
- Overview
- Module Description
- Setup - The basics of getting started with andschwa-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.
Setup
What andschwa-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 andschwa-mumble
The simplest use of this module is:
include mumble
Usage
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
$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.
Development
Fork on GitHub, make a Pull Request.
Dependencies
- puppetlabs/apt (>= 1.4.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.