Murmurguide

From Mumble Wiki
Revision as of 22:50, 20 August 2009 by Snares2 (talk | contribs)
Jump to: navigation, search

Windows

Preparations

Configure Windows

Before you can have Murmur completely working, you need to make a few changes to your network on Windows.

First, make your IP static. Unless you're just going to run this server a few times, you need to make your IP static so that a person outside of your network can dependably connect to your Murmur server. If you have no idea how to make your IP static, read this guide for doing in on Windows XP, and this guide for doing it on Windows Vista.

Configure Network

Now you need to open a port on your computer and/or networking equipment. This port will be the port that Murmur runs on, and the default is 64738 (using the TCP and UDP protocols). If you wish to use a port different than this one, use it instead of port 64738 used in this example. If you are just using Windows' built-in firewall then when you start Murmur it should ask whether or not to allow it. If you are using a third-party software firewall you will need to find the instructions for opening a port on it on your own. To learn how to open the port on your network equipment, we recommend you go to Portforward and select your specific devices from the list. Though Murmur is not currently on the Portforward website, just use some other program in place of it (for instance read the instructions for opening the ports for Call of Duty) but only open the port you want to use for Murmur, ensuring that you are using both TCP and UDP for the port. Remember that ANY device with a firewall between you and the internet must allow the port you are going to use for Murmur on both the TCP and UDP protocols. That means your [wireless] router, Cable or DSL modem, and anything else that has a firewall.

Install Murmur

Now install Murmur. As of the 1.1.8 release, you can choose to only install Murmur, and nothing else. Start the installation and when you come to the installation selection, select at least the Murmur server. You can choose to install Mumble and the debug files if you want, but it is not a requirement. Once you have it installed, it is recommended that you make a shortcut to it in order to easily start it. Go to C:\Program Files\Mumble (or wherever you installed Murmur to), right click on murmur.exe and click "Create Shortcut." Find the shortcut (it will be in the same folder as murmur.exe), right click it, and click "Rename." Type "Murmur" (without the quotes) and press enter. Now drag the Murmur icon onto your desktop.

Setting Up the Server

Setting the SuperUser Password

The first basic step before you start your Murmur server is setting a SuperUser password. The SuperUser is the first user on your Murmur server, and it is vital to initially adding a user to the admin group, and as a backup measure in case something goes terribly wrong with the server (say, it has been hacked).

To set the SuperUser password, press the Windows key and hold it down (it's right between left control and right control) and then press the R key. In the input box of the window that pops up, type cmd and press enter. Now type

cd %ProgramFiles%\Mumble

and press enter. If you installed Murmur to a folder different from this, you need to cd to wherever you decided to install it to.

After you have done that, type

murmur.exe -supw Password_of_your_choice 

(Password_of_your_choice being whatever password you want to give SuperUser) and press enter. A window should pop up that says something like "Superuser password set on server1." Note that this does not start the Murmur server, it only sets the SuperUser password.

Configuring the ini File

In C:\Program Files\Mumble (or wherever you installed Mumble to) there is a file called murmur.ini this contains all the basic settings for Murmur. If you change any of the settings in this ini file, you have to restart Murmur for the changes to apply. It is suggested that you look over and/or configure the lines that start with the following:

welcometext=
port=
serverpassword=
bandwidth=
users=
registerName=

You do not need to change any of these fields for your server to work, but you should change them if you need to. For instance if you do not want your server to be public (that is, any user of Mumble has the potential to enter it) you should set

serverpassword=

to

serverpassword=Password_of_your_choice

(Password_of_your_choice being whatever you want your server password to be.) Uncomment

#registerName=

(change it to)

registerName= 

and set it. This line sets the name of the Root channel of your Murmur server. It is the top channel of the server and if you do not set it, it will have a name of "Root." For instance if you wanted to name the server "FPS Fun" you would set the line to

registerName=FPS Fun

Do not fill out the other

#register* 

fields or uncomment them if you are going to have a server password set. If you want it to be public you must leave the

serverpassword= 

as it is (do not set a password) and you must set the following lines with the proper information and remove the # from them. (# at the beginning of a line comments the entire line, telling the program that reads it to completely ingore the line.) The lines below register the server with the central Mumble server list and make it so that one who browses the servers on the "Server Browser" tab of the connect window can see your server. Read the commented lines in the ini for specific information about these three lines.

#registerName=
#registerPassword=
#registerUrl=

The

#registerHostname=

line is optional and only set it if you have an external static IP. If you are on a home-based DSL or Cable network, you probably should not set this field.

Carefully read the commented text in the ini file for explanations of each of the ini settings you wish to change or set.

Starting Murmur

Once you have configured the ini file to your liking and are ready to start Murmur, start it by double clicking the Murmur icon you put on your desktop. The server should start and you should see a little icon similar to Mumble's in your system tray (the little icons in the bottom right corner of your screen). You can right click this icon and select either "Show Log" to view the log that Murmur generates (users that connect, settings initialized, etc.) or "Quit Murmur" to shut down the Murmur server. If you want Murmur to automatically start with Windows, select the Murmur icon, right click it, and click "Copy." Now right click on your start button, select "Open All Users" and open "Programs\Startup." Right click in an empty space and select "Paste." Now Murmur should start with Windows.

Making And Using a BAT Registration Script

The registrations for Mumble are controlled through two methods, ICE and DBus. The easiest way to register a user on Windows is to use a DBus BAT script. Follow the instructions for creating and using a BAT script here. Before continuing with the guide, you need to register at least one user. For the purposes of this guide, it is assumed that you will register a user with a username of Player and a password of reyalp. You can, of course, register this user with a completely different username and password.

Manually Registering a User

In certain situations, it is impossible to use ICE or DBus to add a user. If you are in this predicament, you can open your murmur.sqlite database with sqlitebrowser and manually add the registration. One method for FTP only servers or the like is to copy the database to your machine, edit the database, then upload the edited database to the server. Remember, make sure you have stopped the Murmur daemon before you edit the database; if you don't do this, you will regret it.

sqlitebrowser usage:

Start sqlitebrowser -> open murmur.sqlite -> click Browse Data tab -> select players table -> click the icon with pencil on it -> select players table -> click Edit -> click Add field -> remove the field you just added -> close window -> click New Record -> double click each field and use the following information: server_id=1 player_id=1 name=<admin> pw=<password you want>

Setting Up Or Configuring Your Server To Use ICE

If you would like to have a remote way to access your Murmur server from a web browser, you can have a look at this guide. It is recommended for the more advanced users and will probably take some troubleshooting in order to get working properly. Once you have it set up, have a look at the various web interfaces here.

This is not a required step in this guide.

Connecting To Your Murmur Server

Now that Murmur is started, start Mumble. When it is started, go to Server -> Connect and click the "Custom Servers" tab. Fill out the

Label
Address 
Port
Username 
Password

fields with the appropriate information.

The Address field is the external IP of your server; if you do not know the external IP, go here (from the computer hosting Murmur): http://whatismyipaddress.com/

The Label field can be set to whatever you want, it is a purely personal choice. We recommend you set it to SuperUser though.

Set

Username

to SuperUser and

Password 

to the password you gave SuperUser when you ran

murmur.exe -supw Password_of_your_choice

When all the information has been filled out, click "Add." Now select the server that appeared in the box on the left and click "Connect." Once in the server, right click the Root channel (it will have the name that you set on the registerName field in the ini) and select "Edit ACL." Now click on the "Groups" tab. In the blank white input box click the down arrow and select "admin." Now on the bottom left input box type Player (the name of the user you registered with the BAT script) and click "Add." If it added successfully, you should see Player in the Add box.

Now add another custom server in Mumble with the same information (Server -> Connect -> Custom Servers tab) but in the

Username

and

Password

fields change SuperUser and Password_of_your_choice to Player and reyalp, respectively (or whatever username and password you set when you ran the BAT registration script). You can now log in as an admin and start setting up ACL's, channels and groups. If you need help understanding ACL's and Groups, read this guide.

Linux