README.md
Mumble Cookbook
===============
[](https://supermarket.chef.io/cookbooks/mumble_server)
[](https://github.com/zuazo/mumble_server-cookbook)
[](https://gemnasium.com/zuazo/mumble_server-cookbook)
[](https://codeclimate.com/github/zuazo/mumble_server-cookbook)
[](https://travis-ci.org/zuazo/mumble_server-cookbook)
[](https://coveralls.io/r/zuazo/mumble_server-cookbook?branch=master)
[Chef](https://www.chef.io/) cookbook to install and configure a [Mumble](http://wiki.mumble.info/wiki/Main_Page) server (called Murmur).
Requirements
============
## Supported Platforms
This cookbook has been tested on the following platforms:
* Debian
* Fedora
* Ubuntu
Please, [let us know](https://github.com/zuazo/mumble_server-cookbook/issues/new?title=I%20have%20used%20it%20successfully%20on%20...) if you use it successfully on any other platform.
## Required Cookbooks
* [runit](https://supermarket.chef.io/cookbooks/runit)
## Required Applications
* Chef `>= 11`
* Ruby `>= 1.9.3`
Attributes
==========
| Attribute | Default | Description |
|:-------------------------------------------|:-------------|:-------------------------------|
| `node['mumble_server']['service_type']` | `'service'` | Mumble server service type. Possible values are: `'service'`, `'runit_service'`.
| `node['mumble_server']['service_timeout']` | `60` | Mumble server service timeout in seconds. Only for runit.
| `node['mumble_server']['config']` | *calculated* | Mumble server configuration Hash. **There is no need to escape values.** See the [example below](#server-configuration-example).
| `node['mumble_server']['verbose']` | *calculated* | Mumble server verbose mode. Only for runit.
## Platform Support Related Attributes
Some cookbook attributes are used internally to support the different platforms. Surely you want to change them if you want to support new platforms or want to improve the support of some platforms already supported.
| Attribute | Default | Description |
|:--------------------------------------------------|:-----------------------------|:-------------------------------|
| `node['mumble_server']['packages']` | `['mumble-server']` | Mumble server required packages as Array.
| `node['mumble_server']['service_runit_packages']` | `['lsof']` | Mumble server required packages for runit.
| `node['mumble_server']['service_name']` | *calculated* | Mumble server service name.
| `node['mumble_server']['service_supports']` | *calculated* | Mumble server service supported actions Hash.
| `node['mumble_server']['config_file']` | `'/etc/murmur/murmur.ini'` | Mumble server configuration file path.
| `node['mumble_server']['config_file_links']` | `['/etc/mumble-server.ini']` | Mumble server file links to create pointing to the configuration file.
| `node['mumble_server']['pid_file']` | *calculated* | Mumble server pidfile path.
| `node['mumble_server']['pid_file_links']` | *calculated* | Mumble server file links to create pointing to the pidfile.
| `node['mumble_server']['user']` | `'mumble-server'` | Mumble server system use.
| `node['mumble_server']['group']` | `'mumble-server'` | Mumble server system group.
Recipes
=======
## mumble_server::default
Installs and configures Mumble server.
Resources
=========
## mumble_server_supw[password]
Changes Mumur SuperUser password.
### mumble_server_supw[password] Actions
* `change` (default)
### mumble_server_supw[password] Parameters
| Parameter | Default | Description |
|:----------|:--------|:--------------------|
| password | *name* | SuperUser password.
Usage Examples
==============
## Including in a Cookbook Recipe
Running it from a recipe:
```ruby
include_recipe 'mumble_server'
```
Don't forget to include the `mumble_server` cookbook as a dependency in the metadata.
```ruby
# metadata.rb
# [...]
depends 'mumble_server'
```
## Including in the Run List
Another alternative is to include the default recipe in your *Run List*.
```json
{
"name": "mumble.example.com",
"[...]": "[...]",
"run_list": [
"[...]",
"recipe[mumble_server]"
]
}
```
## Setting SuperUser Password
```ruby
include_recipe 'mumble_server'
# Set SuperUser password
mumble_server_supw 'PUzcoHohsDiFECHyX0PP'
```
## Server Configuration Example
**Note:** See the [Murmur guide](http://wiki.mumble.info/wiki/Murmurguide) and the [murmur.ini documentation](http://wiki.mumble.info/wiki/Murmur.ini) for more information.
This is the default configuration:
```ruby
# Path to database. If blank, will search for
# murmur.sqlite in default locations or create it if not found.
node.default['mumble_server']['config']['database'] =
'/var/lib/mumble-server/mumble-server.sqlite'
# If you wish to use something other than SQLite, you'll need to set the name
# of the database above, and also uncomment the below.
# Sticking with SQLite is strongly recommended, as it's the most well tested
# and by far the fastest solution.
#
# node.default['mumble_server']['config']['dbDriver'] = ' 'QMYSQL''
# node.default['mumble_server']['config']['dbUsername'] = nil
# node.default['mumble_server']['config']['dbPassword'] = nil
# node.default['mumble_server']['config']['dbHost'] = nil
# node.default['mumble_server']['config']['dbPort'] = nil
# node.default['mumble_server']['config']['dbPrefix'] = 'murmur_'
# node.default['mumble_server']['config']['dbOpts'] = nil
# Murmur defaults to not using D-Bus. If you wish to use dbus, which is one of
# the RPC methods available in Murmur, please specify so here.
#
# node.default['mumble_server']['config']['dbus'] = 'system'
# Alternate D-Bus service name. Only use if you are running distinct
# murmurd processes connected to the same D-Bus daemon.
# node.default['mumble_server']['config']['dbusservice'] =
# 'net.sourceforge.mumble.murmur'
# If you want to use ZeroC Ice to communicate with Murmur, you need
# to specify the endpoint to use. Since there is no authentication
# with ICE, you should only use it if you trust all the users who have
# shell access to your machine.
# Please see the ICE documentation on how to specify endpoints.
# node.default['mumble_server']['config']['ice'] = 'tcp -h 127.0.0.1 -p 6502'
# Ice primarily uses local sockets. This means anyone who has a
# user account on your machine can connect to the Ice services.
# You can set a plaintext "secret" on the Ice connection, and
# any script attempting to access must then have this secret
# (as context with name "secret").
# Access is split in read (look only) and write (modify)
# operations. Write access always includes read access,
# unless read is explicitly denied (see note below).
#
# Note that if this is uncommented and with empty content,
# access will be denied.
# node.default['mumble_server']['config']['icesecretread'] = nil
# node.default['mumble_server']['config']['icesecretwrite'] = nil
# How many login attempts do we tolerate from one IP
# inside a given timeframe before we ban the connection?
# Note that this is global (shared between all virtual servers), and that
# it counts both successfull and unsuccessfull connection attempts.
# Set either Attempts or Timeframe to 0 to disable.
# node.default['mumble_server']['config']['autobanAttempts '] = ' 10'
# node.default['mumble_server']['config']['autobanTimeframe '] = ' 120'
# node.default['mumble_server']['config']['autobanTime '] = ' 300'
# Specifies the file Murmur should log to. By default, Murmur
# logs to the file 'murmur.log'. If you leave this field blank
# on Unix-like systems, Murmur will force itself into foreground
# mode which logs to the console.
node.default['mumble_server']['config']['logfile'] =
'/var/log/mumble-server/mumble-server.log'
# If set, Murmur will write its process ID to this file
# when running in daemon mode (when the -fg flag is not
# specified on the command line). Only available on
# Unix-like systems.
node.default['mumble_server']['config']['pidfile'] =
'/var/run/mumble-server/mumble-server.pid'
# The below will be used as defaults for new configured servers.
# If you're just running one server (the default), it's easier to
# configure it here than through D-Bus or Ice.
#
# Welcome message sent to clients when they connect.
node.default['mumble_server']['config']['welcometext'] =
'<br />Welcome to this server running <b>Murmur</b>.<br />'\
'Enjoy your stay!<br />'
# Port to bind TCP and UDP sockets to.
node.default['mumble_server']['config']['port'] = 64_738
# Specific IP or hostname to bind to.
# If this is left blank (default), Murmur will bind to all available addresses.
# node.default['mumble_server']['config']['host'] = nil
# Password to join server.
node.default['mumble_server']['config']['serverpassword'] = nil
# Maximum bandwidth (in bits per second) clients are allowed
# to send speech at.
node.default['mumble_server']['config']['bandwidth'] = 72_000
# Maximum number of concurrent clients allowed.
node.default['mumble_server']['config']['users'] = 100
# Amount of users with Opus support needed to force Opus usage, in percent.
# node.default['mumble_server']['config']['0 '] =
# ' Always enable Opus, 100 = enable Opus if it's supported by all clients.'
# node.default['mumble_server']['config']['opusthreshold'] = 100
# Maximum depth of channel nesting. Note that some databases like MySQL using
# InnoDB will fail when operating on deeply nested channels.
# node.default['mumble_server']['config']['channelnestinglimit'] = 10
# Regular expression used to validate channel names.
# (Note that you don't have to escape backslashes with \ )
# node.default['mumble_server']['config']['channelname'] =
# '[ \-=\w\#\[\]\{\}\(\)\@\|]+'
# Regular expression used to validate user names.
# (Note that you don't have to escape backslashes with \ )
# node.default['mumble_server']['config']['username'] =
# '[-=\w\[\]\{\}\(\)\@\|\.]+'
# Maximum length of text messages in characters. 0 for no limit.
# node.default['mumble_server']['config']['textmessagelength'] = 5_000
# Maximum length of text messages in characters, with image data. 0 for no
# limit.
# node.default['mumble_server']['config']['imagemessagelength'] = 131_072
# Allow clients to use HTML in messages, user comments and channel descriptions?
# node.default['mumble_server']['config']['allowhtml'] = 'true'
# Murmur retains the per-server log entries in an internal database which
# allows it to be accessed over D-Bus/ICE.
# How many days should such entries be kept?
# Set to 0 to keep forever, or -1 to disable logging to the DB.
# node.default['mumble_server']['config']['logdays'] = 31
# To enable public server registration, the serverpassword must be blank, and
# this must all be filled out.
# The password here is used to create a registry for the server name; subsequent
# updates will need the same password. Don't lose your password.
# The URL is your own website, and only set the registerHostname for static IP
# addresses.
# Only uncomment the 'registerName' parameter if you wish to give your "Root"
# channel a custom name.
#
# node.default['mumble_server']['config']['registerName'] = 'Mumble Server'
# node.default['mumble_server']['config']['registerPassword'] = 'secret'
# node.default['mumble_server']['config']['registerUrl'] =
# 'http://mumble.sourceforge.net/'
# node.default['mumble_server']['config']['registerHostname'] = nil
# If this option is enabled, the server will announce its presence via the
# bonjour service discovery protocol. To change the name announced by bonjour
# adjust the registerName variable.
# See http://developer.apple.com/networking/bonjour/index.html for more
# information about bonjour.
# node.default['mumble_server']['config']['bonjour'] = true
# If you have a proper SSL certificate, you can provide the filenames here.
# Otherwise, Murmur will create it's own certificate automatically.
# node.default['mumble_server']['config']['sslCert'] = nil
# node.default['mumble_server']['config']['sslKey'] = nil
# If Murmur is started as root, which user should it switch to?
# This option is ignored if Murmur isn't started with root privileges.
node.default['mumble_server']['config']['uname'] = node['mumble_server']['user']
# If this options is enabled, only clients which have a certificate are allowed
# to connect.
# node.default['mumble_server']['config']['certrequired'] = false
# If enabled, clients are sent information about the servers version and
# operating system.
# node.default['mumble_server']['config']['sendversion'] = true
# You can configure any of the configuration options for Ice here. We recommend
# leave the defaults as they are.
# Please note that this section has to be last in the configuration file.
#
node.default['mumble_server']['config']['Ice']['Warn.UnknownProperties'] = 1
node.default['mumble_server']['config']['Ice']['MessageSizeMax'] = 65_536
include_recipe 'mumble_server'
```
Testing
=======
See [TESTING.md](https://github.com/zuazo/mumble_server-cookbook/blob/master/TESTING.md).
## ChefSpec Matchers
### mumble_server_supw(password)
Helper method for locating a `mumble_server_supw` resource in the collection.
```ruby
resource = chef_run.mumble_server_supw(password)
expect(resource).to notify('service[apache2]').to(:reload)
```
### change_mumble_server_supw(password)
Assert that the *Chef Run* changes the Mumble Server SuperUser password.
```ruby
expect(chef_run).to change_mumble_server_supw(password)
```
Contributing
============
Please do not hesitate to [open an issue](https://github.com/zuazo/mumble_server-cookbook/issues/new) with any questions or problems.
See [CONTRIBUTING.md](https://github.com/zuazo/mumble_server-cookbook/blob/master/CONTRIBUTING.md).
TODO
====
See [TODO.md](https://github.com/zuazo/mumble_server-cookbook/blob/master/TODO.md).
License and Author
==================
| | |
|:---------------------|:-----------------------------------------|
| **Author:** | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@zuazo.org>)
| **Copyright:** | Copyright (c) 2015, Xabier de Zuazo
| **Copyright:** | Copyright (c) 2014, Onddo Labs, SL.
| **License:** | Apache License, Version 2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.