%
% mumble-server.tex
% Last Update: $Id$
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%% Kapitel mSMTP %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\chapter{mumble-server}
\index{mumble}


\section{Allgemeines}

    Sprachkommunikationsserver f"ur Gamer

    Mumble ist eine quelloffene, unter der BSD lizenzierte
    Sprachkommunikationssoftware, die auf vielen Plattformen l"auft.

    Sprachkommunikation mit niedriger Latenz und hoher Qualit"at f"ur
    Spieler. Enth"alt Game Linking, sodass die Stimme anderer Spieler
    aus der Richtung ihrer Charaktere kommt, und verf"ugt "uber
    Echounterdr"uckung, sodass der Ton aus Ihren Lautsprechern f"ur
    andere Spieler nicht h"orbar ist.


\section{Das Men"u im Setup-Programm}

    Das Men"u im Setup-Programm ist wie folgt aufgebaut:

    \mbox{}

    \begin{tabular}{llll}
    & 4. &  Service administration
    \end{tabular}
\eline
    \begin{tabular}{p{1cm}llll}
    & x. & Mumble Server
    \end{tabular}
\eline
    \begin{tabular}{p{2cm}ll}
    & 1. & View documentation\\
    & 2. & Edit configuration\\
    & 3. & Advanced configuration file handling\\
    & 4. & Show status \\
    & 5. & Stop service \\
    & 6. & Start service \\
    & 7. & Logfile view \\
    \end{tabular}

    \mbox{}


\section{Die "Anderung der Konfiguration}

    Die Konfiguration kann "uber den Men"upunkt
    \glqq{}Edit configuration\grqq{} ge"andert werden.

    Nachdem der Editor beendet wurde, wird abgefragt, ob die Konfiguration
    aktiviert werden soll. Wird dies best"atigt, so werden "uber ein Skript
    die Anpassungen umgehend wirksam gemacht.


\newpage


\section{Die Konfigurationsdatei}

    In der Konfigurationsdatei, die "uber das Men"u zug"anglich ist, sind
    folgende Parameter vorhanden; wer sie von Hand editieren will, findet
    sie unter\\
    \texttt{/etc/config.d/mumble-server}


\section{Die Parameter}


\begin{description}

\config{START\_MUMBLE\_SERVER}
{START\_MUMBLE\_SERVER}
{STARTMUMBLESERVER}
{
    F"ur die Aktivierung des 'mumble-servers' muss dieser Parameter
    lediglich auf den Wert 'yes' gestellt werden.
    Die Einstellung 'no' schaltet den 'mumble-server' ab.

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{START\_MUMBLE\_SERVER='no'}
}



\config{MUMBLE\_SERVER\_WELCOME}
{MUMBLE\_SERVER\_WELCOME}
{MUMBLESERVERWELCOME}
{
    "Uber diesen Parameter wird der Text festgelegt der in der
    Begr"ussung angezeigt wird.

    G"ultige Werte: alles

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_WELCOME='Welcome to Mumble on eisfair'}
}


\config{MUMBLE\_SERVER\_PORT}
{MUMBLE\_SERVER\_PORT}
{MUMBLESERVERPORT}
{
    "Uber diesen Parameter wird festgelegt "uber welchen Port
    der Mumble Server erreicht werden soll

    G"ultige Werte: Portummer

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_PORT='64738'}
}


\config{MUMBLE\_SERVER\_PASSWD}
{MUMBLE\_SERVER\_PASSWD}
{MUMBLESERVERPASSWD}
{
    "Uber diesen Parameter wird das Passwort festgelegt,
    mit dem die Anmeldung am Mumble Server erfolgt. Optional.

    G"ultige Werte: Passwort

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_PASSWD='{}'}
}


\config{MUMBLE\_SERVER\_REGISTER\_NAME}
{MUMBLE\_SERVER\_REGISTER\_NAME}
{MUMBLESERVERREGISTERNAME}
{
    "Uber diesen Parameter wird der Registrierte Name festgelegt,
    der Anstelle 'root' angezeigt wird.

    G"ultige Werte: Name

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_REGISTER\_NAME='Mumble Server'}
}


\config{MUMBLE\_SERVER\_REGISTER\_PASSWORD}
{MUMBLE\_SERVER\_REGISTER\_PASSWORD}
{MUMBLESERVERREGISTERPASSWORD}
{
    Optional:
    Passwort f"ur den Registrierungsvorgang. Dieses Passwort verhindert,
    dass jemand einen Eintrag in der Serverliste "uberschreiben kann und
    sich als dieser Server ausgeben kann.

    G"ultige Werte: Passwort

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_REGISTER\_PASSWORD='{}'}
}


\config{MUMBLE\_SERVER\_REGISTER\_URL}
{MUMBLE\_SERVER\_REGISTER\_URL}
{MUMBLESERVERREGISTERURL}
{
    Optional:
    Diese URL wird aufgerufen, wenn der Benutzer in der Serverliste des
    Mumble-Clients auf 'Webseite "offnen' klickt.

    G"ultige Werte: URL

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_REGISTER\_URL='{}'}
}


\config{MUMBLE\_SERVER\_REGISTER\_HOSTNAME}
{MUMBLE\_SERVER\_REGISTER\_HOSTNAME}
{MUMBLESERVERREGISTERHOSTNAME}
{
    Optional:
    Hostname des Servers wie er in der Serverliste erscheint.
    Wer eine eigene Domain hat, kann diese hier eintragen. Ansonsten die
    IP des Servers.

    G"ultige Werte: Name

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_REGISTER\_HOSTNAME='{}'}
}


\config{MUMBLE\_SERVER\_REGISTER\_LOCATION}
{MUMBLE\_SERVER\_REGISTER\_LOCATION}
{MUMBLESERVERREGISTERLOCATION}
{
    Optional:
    Wenn diese Variable gesetzt ist, landet der Server in der offiziellen
    Serverliste nicht anhand der IP-Adresse im entsprechenden Land, sondern
    in dem Land, das dem Landesk"urzel entspricht.

    G"ultige Werte: Landesk"urzel

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_REGISTER\_LOCATION='{}'}
}


\config{MUMBLE\_SERVER\_ALLOW\_PING}
{MUMBLE\_SERVER\_ALLOW\_PING}
{MUMBLESERVERALLOWPING}
{
    Optional:
    Um als Client in der Serverliste sehen zu k"onnen, wie viele Benutzer
    sich auf einem Server befinden, werden spezielle Pakete an den Port
    des Servers geschickt. Mittels false sendet der Server diese Pakete
    nicht.

    Wird diese Variable auf false gesetzt, so wird der Server auch bei
    sonst richtiger Konfiguration nicht in die offizielle Serverliste
    eingetragen.

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{MUMBLE\_SERVER\_ALLOW\_PING='no'}
}
\end{description}
