Difference between revisions of "Mumble URL"

From Mumble Wiki
Jump to: navigation, search
(Channels)
Line 1: Line 1:
Mumble supports an own URL concept which enables you to join Mumble servers by a click of a link on a website, via links in your Desktop system or via the "Run" dialog of your system. If you have compiled Mumble from it's sources by yourself, the feature will not be available at first. You will have to register Mumble as a protocol handler for it's own URL type for your Desktop system in that case. If you installed Mumble with it's official installer, Mumble URLs should be accepeted by your Desktop system.
+
Mumble supports an own URL concept which enables you to join Mumble servers by a click of a link on a website, via links in your Desktop system or via the "Run" dialog of your system.  
  
 
Mumble will also accept URLs as command line arguments:
 
Mumble will also accept URLs as command line arguments:
Line 6: Line 6:
  
 
  mumble.exe mumble://172.16.31.199/
 
  mumble.exe mumble://172.16.31.199/
 +
 +
== URL Handler Installation ==
 +
 +
If you have compiled Mumble from it's sources by yourself, the feature will not be available at first. You will have to register Mumble as a protocol handler for it's own URL type for your Desktop system in that case. If you installed Mumble with it's official installer, Mumble URLs should be accepeted by your Desktop system, in that case, you can ignore this section.
 +
 +
=== Gnome ===
 +
 +
To enable Mumble URLs in the Gnome Desktop System on Linux, you have to execute the following commands:
 +
 +
gconftool-2 -s -t string /desktop/gnome/url-handlers/mumble/command 'mumble "%s"'
 +
gconftool-2 -s -t bool /desktop/gnome/url-handlers/mumble/enabled true
 +
 +
If the "mumble" command is not globally accessible through the PATH environment variable, you must specify it's full path instead of the last "mumble" in the first of the two commands above.
  
 
== URL Composition ==
 
== URL Composition ==

Revision as of 15:30, 4 April 2008

Mumble supports an own URL concept which enables you to join Mumble servers by a click of a link on a website, via links in your Desktop system or via the "Run" dialog of your system.

Mumble will also accept URLs as command line arguments:

Example:

mumble.exe mumble://172.16.31.199/

URL Handler Installation

If you have compiled Mumble from it's sources by yourself, the feature will not be available at first. You will have to register Mumble as a protocol handler for it's own URL type for your Desktop system in that case. If you installed Mumble with it's official installer, Mumble URLs should be accepeted by your Desktop system, in that case, you can ignore this section.

Gnome

To enable Mumble URLs in the Gnome Desktop System on Linux, you have to execute the following commands:

gconftool-2 -s -t string /desktop/gnome/url-handlers/mumble/command 'mumble "%s"'
gconftool-2 -s -t bool /desktop/gnome/url-handlers/mumble/enabled true

If the "mumble" command is not globally accessible through the PATH environment variable, you must specify it's full path instead of the last "mumble" in the first of the two commands above.

URL Composition

Simple Server Address

Scheme:

mumble://[SERVER ADDRESS]:[PORT]/

Examples:

mumble://server.com/
mumble://172.16.31.199/
mumble://server.com:23840/
mumble://172.16.31.199:2000/

This method simply enables you to join a server via an URL. Mumble will ask you instantly for your username and, if needed, for your password. As you can see in the examples, you are free to specify either an IP address or a DNS Name which represents the server you want to join. If the Mumble server does not listen on the default Mumble Port (64738), you can specify a port number after a separating colon.

Username

Scheme:

mumble://[USERNAME]@[SERVER ADDRESS]:[PORT]/

Examples:

mumble://TestUser@server.com/
mumble://TheGimp@172.16.31.199/
mumble://TestUser@server.com:23840/
mumble://TheGimp@172.16.31.199:2000/

This method simply enables you to join a server via an URL with an already specified username. Mumble will ask you instantly for your password, if this should be needed.

Username and Password

Scheme:

mumble://[USERNAME]:[PASSWORD]@[SERVER ADDRESS]:[PORT]/

Examples:

mumble://TestUser:mypassword@server.com/
mumble://TheGimp:ilovezed@172.16.31.199/
mumble://TestUser:mypassword@server.com:23840/
mumble://TheGimp:ilovezed@172.16.31.199:2000/

This method simply enables you to join a server via an URL with an already specified username and a password.

Channels

Scheme:

mumble://[USERNAME]:[PASSWORD]@[SERVER ADDRESS]:[PORT]/[CHANNEL]/[SUBCHANNEL]/[SUBSUBCHANNEL]/.../

Examples:

mumble://server.com/Root/Open%20Talk/Subchannel%20A/
mumble://172.16.31.199/Root/TestChannel/
mumble://server.com:23840/Root/Open%20Talk/Subchannel%20A/
mumble://172.16.31.199:2000/Root/TestChannel/

mumble://TestUser@server.com/Root/Open%20Talk/Subchannel%20A/
mumble://TheGimp@172.16.31.199/Root/TestChannel/
mumble://TestUser@server.com:23840/Root/Open%20Talk/Subchannel%20A/
mumble://TheGimp@172.16.31.199:2000/Root/TestChannel/

mumble://TestUser:mypassword@server.com/Root/Open%20Talk/Subchannel%20A/
mumble://TheGimp:ilovezed@172.16.31.199/Root/TestChannel/
mumble://TestUser:mypassword@server.com:23840/Root/Open%20Talk/Subchannel%20A/
mumble://TheGimp:ilovezed@172.16.31.199:2000/Root/TestChannel/

mumble://server.com/Open%20Talk/Subchannel%20A/Root/TestChannel/
mumble://172.16.31.199/TestChannel/
mumble://server.com:23840/Open%20Talk/Subchannel%20A/
mumble://172.16.31.199:2000/TestChannel/

mumble://TestUser@server.com/Open%20Talk/Subchannel%20A/
mumble://TheGimp@172.16.31.199/TestChannel/
mumble://TestUser@server.com:23840/Open%20Talk/Subchannel%20A/
mumble://TheGimp@172.16.31.199:2000/TestChannel/

mumble://TestUser:mypassword@server.com/Open%20Talk/Subchannel%20A/
mumble://TheGimp:ilovezed@172.16.31.199/TestChannel/
mumble://TestUser:mypassword@server.com:23840/Open%20Talk/Subchannel%20A/
mumble://TheGimp:ilovezed@172.16.31.199:2000/TestChannel/

This method enables you to join a server while specifying, in which channel you want to join. As all Mumble servers contain a "Root" channel, you can choose if you want to type the root channel in your URL. As you can see in the examples, you can combine this method with the methods described before. If your channel name contain whitespaces, you have to type "%20" instead of that whitespace. If some other characters make problems, get it's hexadecimal number from an ASCII table and replace the character like the whitespace with a "%" in front of it.