Forge Home

mumble

Install and Manage a Mumble Server

10,193 downloads

9,806 latest version

3.5 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.3 (latest)
  • 0.0.2
released May 8th 2014

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'andschwa-mumble', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add andschwa-mumble
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install andschwa-mumble --version 0.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

andschwa/mumble — version 0.0.3 May 8th 2014

andschwa-mumble

Table of Contents

  1. Overview
  2. Module Description
  3. Setup - The basics of getting started with andschwa-mumble
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.
  6. 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.