Difference between revisions of "Running Murmur"

From Mumble Wiki
Jump to: navigation, search
m (Web-Interfaces: Changed MAP settings)
m (Settings, Ports, and Authentication: - Added mention to SRV record configuration)
(99 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 +
'''If you find anything incorrect or missing in this article feel free to add it yourself. After you register, you must wait three days before you can edit a page.'''
 
= Introduction =
 
= Introduction =
Murmur is the server component for Mumble. This article is meant to give you the necessary information to configure and run your own server. If you need a step-by-step guide to help you set up a Murmur server, read [[Murmurguide|this]].
+
{{Notice
 +
|message=For a step-by-step guide to setting up a Murmur server, read '''[[Murmurguide|Murmur Guide]]'''.
  
'''If you find anything incorrect or missing in this article feel free to add it yourself.'''
+
}}
 +
Murmur is the server component for Mumble. This article is meant to give you the necessary information to configure and run your own server.
  
= Distribution-specific Murmur =
+
= Distribution-Specific Murmur =
  
By default, murmur is configured to run from a regular user account, and on Windows and OSX this is the only way it works. However, on distributions with prepackaged murmur (Debian/Ubuntu), murmur is configured to run as a sytem service, just like your webserver, mailserver and whatever else you've got running. This "global" installation is a ready, turn-key solution, most of the information here does not apply to you. Most packages also include the 'murmur-user-wrapper' script, which does all of the below for you if you want to run as a regular user (including starting DBus).
+
By default, Murmur is configured to run from a regular user account, and on Windows and OSX this is the only way it works.  
  
So, on these systems, you can still run murmur manually, but you will then not benefit from the extensive care that has gone into preparing those packages.
+
However, on distributions with prepackaged Murmur (Debian/Ubuntu), Murmur is configured to run as a system service, just like your webserver, mailserver and whatever else you have running. This "global" installation is a ready, turn-key solution, most of the information here does not apply to you. Most packages also include the 'murmur-user-wrapper' script, which does all of the below for you if you want to run as a regular user (including starting DBus).
  
If you need to register users or change the settings of a virtual server, read the section on Advanced Configuration.
+
So, on these systems, you can still run Murmur manually, but you will then not benefit from the extensive care that has gone into preparing those packages.
  
= Basic configuration =
+
If you need to register users externally, or change the settings of a virtual server, read the section on Advanced Configuration.
  
The default settings for a murmur server are configured in ''murmur.ini''. Here you can configure the welcome text, port number and other settings. However, these are just default settings and can be overwritten via the [[Ice]] RPC without changing the .ini; if you're running multiple virtual servers, each virtual server has it's own configuration, which is maintained internally by Murmur (see below).
+
= Basic Configuration =
  
The default port for a Murmur server is UDP and TCP 64738. Have a look at [[URLs]] to see how to publish links to your server.
+
== Settings, Ports, and Authentication ==
 +
The default settings for a Murmur server are configured in ''[[murmur.ini]]''. Here, you can configure the welcome text, port number and other settings. However, these are just default settings and can be overwritten via the [[Ice]] RPC without changing the .ini; if you're running multiple virtual servers, each virtual server has its own configuration, which is maintained internally by Murmur (see below).
  
Adding an authenticated user can be done through various means. Unless you need automated registration of users or authentication against an external database using the functionality built into the client is the easiest method. If you need more control you can use [http://mumble.sourceforge.net/Ice Ice] or [http://mumble.sourceforge.net/DBus DBus].
+
The default port for a Murmur server is UDP and TCP 64738.
 +
<br>
 +
Have a look at [[Mumble URL]] to see how to publish links to your server, and [[SRV_Record | SRV Record configuration]].
  
== Setting the SuperUser password ==
+
Adding an authenticated user can be done through various means. Unless you need automated registration of users or authentication against an external database using the functionality built into the client is the easiest method. If you need more control you can use [[Ice]] or [[DBus]].
  
Until you've set a password for the SuperUser, the account will be disabled. You don't need the SuperUser account to run a simple server, but you do need it if you want to give your regular user account any privileges. To set the password on Linux run
+
== Setting the SuperUser Password ==
  murmurd -supw <password>
+
{{Notice
This will set the password and return immediately. To run the server remove this parameter. If you are on a debian based system, you may also run
+
|message=Note this command can be run seperately while the server is running to change the password without restarting.  Also note that in 1.2.2 at least, you must run the server normally at least once before trying to set this.
 +
}}
 +
 
 +
{{Notice
 +
|message=For older versions the SuperUser account is disabled until you setup the password. You don't need the SuperUser account to run a simple server, but you do need it if you want to give your regular user account any privileges.  
 +
}}
 +
 
 +
In version >=1.2.4 the SuperUser password is generated automatically on the first server start. You can find it in the logfile. Search for an entry like <code><W>2013-09-03 11:23:44.516 1 => Password for 'SuperUser' set to 'supersecretpassword'</code>. You can of course change this password.
 +
 
 +
To set/change the password on the Linux static server, run
 +
  murmur.x86 -ini <path to configuration file> -supw <password> [srv]
 +
To set the password on Debian-based systems, run
 +
<pre>
 +
# EITHER use the dpkg management facilities
 
  sudo dpkg-reconfigure mumble-server
 
  sudo dpkg-reconfigure mumble-server
  
If you're on Windows, then you set the password by running
+
# OR run the server binary manually
  "C:\Program Files\Mumble\murmur.exe" -supw <password>
+
sudo -i murmurd -ini /etc/mumble-server.ini -supw <password> [srv]
 +
</pre>
 +
To set the password on Windows systems, run
 +
  <path to murmur.exe> -ini <path to configuration file> -supw <password> [srv]
  
= Running Murmur as a regular user =
+
Make sure the <tt>-ini</tt> parameter is the same as for running the server normally to make sure the password gets set in the right database file. If the command does not seem to work, double-check that you are supplying the right path.
  
If you are on Win32, you can simply start ''murmur.exe'' from the command line, or even easier just start it from the Start Menu.
+
The <tt>[srv]</tt> parameter is the ID of the virtual Mumble-Server you want to change password for. If omitted, ID 1 is used (for the first virtual server).
  
== RPC-Interfaces ==
+
This will only set the password and then terminate, it will not start the server. To run the server, start it without the <tt>-supw</tt> parameter.
  
For full functionality, murmur requires either a working [[DBus]] daemon or [[Ice]] being enabled. We recommend using the [[Ice]] interface, as [[DBus]] is considered deprecated and while it is not planned to remove it anytime soon it will not receive any new functionality.
+
== Starting Murmur ==
  
== Running the daemon ==
+
To start Murmur,
  
To run murmur, simply type
+
On a static Linux build, cd to the directory where you extracted the files and do
  murmurd
+
  murmur.x86
For debugging, you might want to add ''-fg -v'' to the command line, which will stop the program from running in the background and.
+
On Debian-based,
 +
sudo dpkg-reconfigure mumble-server
 +
On Windows,
 +
<path to murmur.exe> (usually C:\Program Files\Mumble\Murmur.exe)
  
By default murmur opens it's configuration file, database file and logfile in your current directory. The configuration file can be overridden with the ''-ini'' parameter, and the database and logfile can be set form the ini file.
+
For debugging or real time logging, you might want to add ''-fg -v'' to the command line, which will stop the program from running in the background.
  
 +
By default, Murmur opens its configuration file, database file and logfile in your current directory. The configuration file can be overridden with the ''-ini'' parameter, and the database and logfile can be set from the ini file, using their respective parameters.
  
= Administration =
+
= Advanced Configuration and Administration=
This section contains different ways of administrating a murmur Server.
 
  
'''Note:''' Most of these interfaces are created and maintained by third parties and the Mumble developers have no influence on the stability and/or security of these projects.
+
To make use of a strong server certificate the users will not have to manually accept, please see [[Obtaining a Let's Encrypt Murmur Certificate]] and [[Obtaining a Comodo Murmur certificate]].
  
== Web-Interfaces ==
+
{{Notice
 +
|message=Most of these interfaces are created and maintained by third parties and the Mumble developers have no influence on the stability and/or security of these projects.
  
There are several browser based interfaces which can be used to administrate the Murmur server. If you need something very basic or want to create your own interface you should take a look at Murmurs [http://mumble.git.sourceforge.net/git/gitweb.cgi?p=mumble;a=tree;f=scripts script folder] which contains some basic web-interface examples which use [[Ice]] or [[DBus]].
+
Also, nearly all of the basic administration tasks can be completed '''through the client''' when using > Mumble 1.2.x.
Additionally the following table contains a collection of more elaborate Web-Interfaces:
+
}}
 +
== Compatibility With RPC-Interfaces ==
  
{|border="0" cellpadding="2" cellspacing="1" style="background:#e2e2e2;" class="sortable"
+
For full functionality with an RPC interface, Murmur requires either a working [[DBus]] daemon or [[Ice]] installation that is enabled. We recommend using the [[Ice]] interface; [[DBus]] is considered deprecated and although it will not be removed in the near future, it is not receiving any new functionality. Once you have Murmur working with the RPC interface, you can install a compatible web interface; see below for possible options.
! Name
 
! Technology
 
! [[DBus]]
 
! [[Ice]]
 
! 1.1.8
 
! 1.2.0
 
! Comment
 
! Weblink
 
  
|-bgcolor="#f8f8ff"
+
== Authenticating With an External Database/Forum ==
| [[Mumble PHP Interface]]
 
| [http://php.net/ PHP]
 
| bgcolor=#ffdddd | No
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | No
 
| User and Admin functionality
 
| [http://kissaki.clandooc.de/mumble/interfaces/PHP_Interface.php]
 
  
 +
===Ice===
 +
For phpBB3, there is [https://github.com/mumble-voip/mumble-scripts/tree/master/Authenticators/phpBB3 phpBB3auth]. You must point the python script to the ini file; read the in-source documentation for more infomation.
  
|-bgcolor="#f8f8ff"
+
For SMF (Simple Machines Forum), there is [https://github.com/mumble-voip/mumble-scripts/tree/master/Authenticators/SMF smfauth]. You must point the python script to the ini file; read the in-source documentation for more infomation.
| [[MAP - Mumb1e Admin Plugin]]
 
| [http://php.net/ PHP]
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | Yes
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | planed
 
| Webinterface to manage Server User, Plugin User and virtual Servers; request function for Server Users; useful for Server hosting; uses DBUS or Slice or nothing; Channelviewer for own homepage; German, English, Frensh; Template functions and more!
 
| [http://www.mumb1e.de/]
 
  
|-bgcolor="#f8f8ff"
+
===DBus===
| [[MurmurCP]]
 
| [http://www.asp.net/ ASP.NET] + [http://www.zeroc.com/ ICE]
 
| bgcolor=#ffdddd | No
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | No
 
| Multiple Virtual Servers, Registration, Server Status, Forgot Password
 
| [http://murmurcp.hiddenservers.org]
 
  
|-bgcolor="#f8f8ff"
+
There is an extended example of how to use the authenticator called ''scripts/dbusauth.pl''. You'll need to configure where your phpBB3 database resides, but once that is done you'll simply have to run the script after starting murmur to allow authentication to be done through the phpBB3 database.
| [[Mumble-Django]]
 
| [http://www.python.org Python] + [http://www.djangoproject.com Django]
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ddffdd | Yes
 
| Channel viewer, admin panel, multiserver, registration, textures
 
| [http://bitbucket.org/Svedrin/mumble-django/wiki/Home]
 
  
|-bgcolor="#f8f8ff"
+
Any group associations the user has on phpBB3 is copied to a temporary group on a root channel (and by default inherited to all subchannels). Please note that this is a temporary group membership and as such will not show up in the Edit ACL dialogs.
| [[Simpleregister]]
 
| [http://php.net/ PHP]
 
| bgcolor=#ffdddd | No
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | No
 
| Extended script from the sample folder
 
| [http://kissaki.clandooc.de/mumble/interfaces/simpleregister.php]
 
  
|-bgcolor="#f8f8ff"
+
== 3rd Party Applications ==
| [[Mumble Admin Ice PHP]]
 
| [http://php.net/ PHP]
 
| bgcolor=#ffdddd | No
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | No
 
| Admin functionality
 
| [http://bitbucket.org/gallagher/mumble-admin-ice-php/downloads/Mumble_Admin.zip]
 
|}
 
  
<small>Note: We recommend using a preferably [[Ice]] or at least [[DBus]] capable interface.</small>
+
If you are planning to administrate your Murmur server with an external 3rd Party Application, see the following pages for further information.
  
== Standalone applications ==
+
* '''[[3rd_Party_Applications#Web-Interfaces|Web-Interfaces]]'''
{|border="0" cellpadding="2" cellspacing="1" style="background:#e2e2e2;" class="sortable"
+
* '''[[3rd_Party_Applications#Standalone Applications|Standalone Applications]]'''
! Name
+
* '''[[3rd_Party_Applications#Commandline-Interfaces|Commandline-Interfaces]]'''
! OS
 
! [[DBus]]
 
! [[Ice]]
 
! Comment
 
! Weblink
 
  
|-bgcolor="#f8f8ff"
+
{{Notice
| [[Murmur Admin Console]]
+
|message=The aforementioned categories have been moved to the page '''[[3rd_Party_Applications|3rd Party Applications]]'''.
| [http://de.wikipedia.org/wiki/Microsoft_Windows Windows]
+
}}
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | No
 
| Add, edit and delete players over SSH
 
| [http://bograt.com/Murmur/]
 
|}
 
  
== Commandline-Interfaces ==
+
== Manual Configuration Using DBus ==
{|border="0" cellpadding="2" cellspacing="1" style="background:#e2e2e2;" class="sortable"
 
! Name
 
! OS
 
! [[DBus]]
 
! [[Ice]]
 
! Comment
 
! Weblink
 
  
|-bgcolor="#f8f8ff"
+
If you are not able to use an additional application for administrating Murmur there is still the possibility of manually communicating with the server using [[DBus]]. You can find detailed information on this in our [[DBus|DBus article]].
| [[MurmurCL]]
 
| multi-platform
 
| bgcolor=#ffdddd | No
 
| bgcolor=#ddffdd | Yes
 
| Commandline interface written in [http://www.python.org Python]
 
| [http://d0t.dbclan.de/dump/murmurcldist.exe win32 exe] / [http://nodefab.de/git/?p=mumble-scripts.git;a=blob_plain;f=murmurcl.py;hb=HEAD python source]
 
  
|-bgcolor="#f8f8ff"
+
= Alternative Murmur Implementations =
| [[mice]]
+
The Mumble team appreciates and supports the implementation of the Mumble protocol. Unlike other proprietary applications, everyone is free to implement their own Mumble server software and add it to this list.
| multi-platform
+
| bgcolor=#ffdddd | No
+
== uMurmur ==
| bgcolor=#ddffdd | Yes
+
uMurmur is a minimalistic Murmur implementation without dependency on QT-core. It lacks features of Murmur but aims at working well on embedded devices like routers.  
| Helper script written in [http://www.python.org Python]
 
| [http://nodefab.de/git/?p=mumble-scripts.git;a=blob_plain;f=mice.py;hb=HEAD]
 
 
 
|-bgcolor="#f8f8ff"
 
| [[RegMum]]
 
| [http://de.wikipedia.org/wiki/Microsoft_Windows Windows]
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | No
 
| Bat script
 
| [http://mumble.sourceforge.net/DBus_scripts#Windows]
 
  
|-bgcolor="#f8f8ff"
+
It supports 1.2.x Mumble clients in the uMurmur 0.2.x releases and 1.1.x clients in 0.1.x releases. Packages are available for [https://dev.openwrt.org/ticket/6829 OpenWRT], [http://trac.freetz.org/ticket/714 Freetz] and [http://www.nas-forum.com/forum/index.php/files/file/252-umurmur-021-ds-207/ Synology].
| [[mmctl]]
 
| [http://www.python.org Python]
 
| bgcolor=#ddffdd | Yes
 
| bgcolor=#ffdddd | No
 
| 1.1.8
 
| Easy to use script for managing servers and adding users locally
 
| [http://github.com/mbr/mmctl]
 
|}
 
  
== Manual configuration using DBus ==
+
Read more at [http://umurmur.net the uMurmur project page].
  
If you are not able to use an additional application for administrating Murmur there is still the possibility of manually communicating with the server using [[DBus]]. You can find detailed information on this in our [[DBus|DBus article]].
 
  
= Alternative Murmur implementations =
+
[[Category:Documentation English]]
The Mumble team appreciates and supports the implementation of the Mumble protocol. Unlike other proprietary applications everyone is free to write his own Mumble server software and add it to this list.
 
== uMurmur ==
 
uMurmur is a minimalistic Murmur implementation without dependency on QT-core. It lacks features of Murmur but aims at working well on embedded devices like routers. It currently supports 1.1.x Mumble clients. Read more at [http://code.google.com/p/umurmur/ the uMurmur project page].
 
[[Category:Documentation]]
 

Revision as of 09:33, 12 November 2019

If you find anything incorrect or missing in this article feel free to add it yourself. After you register, you must wait three days before you can edit a page.

Introduction

Icons oxygen 48x48 actions view-pim-notes.png
Note:
For a step-by-step guide to setting up a Murmur server, read Murmur Guide.

Murmur is the server component for Mumble. This article is meant to give you the necessary information to configure and run your own server.

Distribution-Specific Murmur

By default, Murmur is configured to run from a regular user account, and on Windows and OSX this is the only way it works.

However, on distributions with prepackaged Murmur (Debian/Ubuntu), Murmur is configured to run as a system service, just like your webserver, mailserver and whatever else you have running. This "global" installation is a ready, turn-key solution, most of the information here does not apply to you. Most packages also include the 'murmur-user-wrapper' script, which does all of the below for you if you want to run as a regular user (including starting DBus).

So, on these systems, you can still run Murmur manually, but you will then not benefit from the extensive care that has gone into preparing those packages.

If you need to register users externally, or change the settings of a virtual server, read the section on Advanced Configuration.

Basic Configuration

Settings, Ports, and Authentication

The default settings for a Murmur server are configured in murmur.ini. Here, you can configure the welcome text, port number and other settings. However, these are just default settings and can be overwritten via the Ice RPC without changing the .ini; if you're running multiple virtual servers, each virtual server has its own configuration, which is maintained internally by Murmur (see below).

The default port for a Murmur server is UDP and TCP 64738.
Have a look at Mumble URL to see how to publish links to your server, and SRV Record configuration.

Adding an authenticated user can be done through various means. Unless you need automated registration of users or authentication against an external database using the functionality built into the client is the easiest method. If you need more control you can use Ice or DBus.

Setting the SuperUser Password

Icons oxygen 48x48 actions view-pim-notes.png
Note:
Note this command can be run seperately while the server is running to change the password without restarting. Also note that in 1.2.2 at least, you must run the server normally at least once before trying to set this.
Icons oxygen 48x48 actions view-pim-notes.png
Note:
For older versions the SuperUser account is disabled until you setup the password. You don't need the SuperUser account to run a simple server, but you do need it if you want to give your regular user account any privileges.

In version >=1.2.4 the SuperUser password is generated automatically on the first server start. You can find it in the logfile. Search for an entry like <W>2013-09-03 11:23:44.516 1 => Password for 'SuperUser' set to 'supersecretpassword'. You can of course change this password.

To set/change the password on the Linux static server, run

murmur.x86 -ini <path to configuration file> -supw <password> [srv]

To set the password on Debian-based systems, run

 # EITHER use the dpkg management facilities
 sudo dpkg-reconfigure mumble-server

 # OR run the server binary manually
 sudo -i murmurd -ini /etc/mumble-server.ini -supw <password> [srv]

To set the password on Windows systems, run

<path to murmur.exe> -ini <path to configuration file> -supw <password> [srv]

Make sure the -ini parameter is the same as for running the server normally to make sure the password gets set in the right database file. If the command does not seem to work, double-check that you are supplying the right path.

The [srv] parameter is the ID of the virtual Mumble-Server you want to change password for. If omitted, ID 1 is used (for the first virtual server).

This will only set the password and then terminate, it will not start the server. To run the server, start it without the -supw parameter.

Starting Murmur

To start Murmur,

On a static Linux build, cd to the directory where you extracted the files and do

murmur.x86

On Debian-based,

sudo dpkg-reconfigure mumble-server

On Windows,

<path to murmur.exe> (usually C:\Program Files\Mumble\Murmur.exe)

For debugging or real time logging, you might want to add -fg -v to the command line, which will stop the program from running in the background.

By default, Murmur opens its configuration file, database file and logfile in your current directory. The configuration file can be overridden with the -ini parameter, and the database and logfile can be set from the ini file, using their respective parameters.

Advanced Configuration and Administration

To make use of a strong server certificate the users will not have to manually accept, please see Obtaining a Let's Encrypt Murmur Certificate and Obtaining a Comodo Murmur certificate.

Icons oxygen 48x48 actions view-pim-notes.png
Note:
Most of these interfaces are created and maintained by third parties and the Mumble developers have no influence on the stability and/or security of these projects. Also, nearly all of the basic administration tasks can be completed through the client when using > Mumble 1.2.x.

Compatibility With RPC-Interfaces

For full functionality with an RPC interface, Murmur requires either a working DBus daemon or Ice installation that is enabled. We recommend using the Ice interface; DBus is considered deprecated and although it will not be removed in the near future, it is not receiving any new functionality. Once you have Murmur working with the RPC interface, you can install a compatible web interface; see below for possible options.

Authenticating With an External Database/Forum

Ice

For phpBB3, there is phpBB3auth. You must point the python script to the ini file; read the in-source documentation for more infomation.

For SMF (Simple Machines Forum), there is smfauth. You must point the python script to the ini file; read the in-source documentation for more infomation.

DBus

There is an extended example of how to use the authenticator called scripts/dbusauth.pl. You'll need to configure where your phpBB3 database resides, but once that is done you'll simply have to run the script after starting murmur to allow authentication to be done through the phpBB3 database.

Any group associations the user has on phpBB3 is copied to a temporary group on a root channel (and by default inherited to all subchannels). Please note that this is a temporary group membership and as such will not show up in the Edit ACL dialogs.

3rd Party Applications

If you are planning to administrate your Murmur server with an external 3rd Party Application, see the following pages for further information.

Icons oxygen 48x48 actions view-pim-notes.png
Note:
The aforementioned categories have been moved to the page 3rd Party Applications.

Manual Configuration Using DBus

If you are not able to use an additional application for administrating Murmur there is still the possibility of manually communicating with the server using DBus. You can find detailed information on this in our DBus article.

Alternative Murmur Implementations

The Mumble team appreciates and supports the implementation of the Mumble protocol. Unlike other proprietary applications, everyone is free to implement their own Mumble server software and add it to this list.

uMurmur

uMurmur is a minimalistic Murmur implementation without dependency on QT-core. It lacks features of Murmur but aims at working well on embedded devices like routers.

It supports 1.2.x Mumble clients in the uMurmur 0.2.x releases and 1.1.x clients in 0.1.x releases. Packages are available for OpenWRT, Freetz and Synology.

Read more at the uMurmur project page.