Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: DOCS: Add Userguides to the documentation. #4628

Closed
wants to merge 16 commits into from
39 changes: 24 additions & 15 deletions docs/user-guides/server_config_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The Configuration involves three steps:
<!-- In addition there are some other interesting topics:

- Bots (Music Bots)
- Web interfaces
- gRPC (remote control)
- Web interfaces (outdated)
- gRPC (remote control) (buggy, not ready)
- WebRTC bridge

-->
Expand All @@ -23,9 +23,7 @@ The Configuration involves three steps:

Users connect to your server via an IP or a Domainname (e.g. `mumble.example.com`).

To make this work continuously, you either need a static IP (that means: it does not change) or in case you have a dynamic IP (it changes every few days), a Dynamic DNS Service.

Otherwise you would need to send the new IP to your users, every time the IP changes.
To make this work continuously, you either need a static IP (that means: the IP does not change) or in case you have a dynamic IP (it changes every few days), a Dynamic DNS Service (see below). Otherwise you would need to send the new IP to your users, every time the IP changes.

*Tip:*

Expand All @@ -44,11 +42,13 @@ For more information and a list of services and software, take a look at the [Ar
### Firewall & Ports

In order for your users to be able to connect to your server, you need to allow incoming connections to a specific Port that the Mumble Server uses.
The Standardport is `64738` (recommended), but you can change it to every available port (it is defined in the main configuration file (`murmur.ini`)).

The Standardport is `64738` (recommended).
toby63 marked this conversation as resolved.
Show resolved Hide resolved
You can also change it to every available port by editing the main configuration file (`murmur.ini`; see below).

**Note:** Use a port that is not standardized (widely used by known programs/services), see e.g. [Wikipedia - List of Ports](https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers).

Allow it for both protocols (TCP and UDP).
Allow connections to the Port for both protocols (TCP and UDP).
toby63 marked this conversation as resolved.
Show resolved Hide resolved

Check and adjust your:

Expand All @@ -60,16 +60,25 @@ Check and adjust your:

## Main configuration file

<!-- List (&explain) the most important options -->
The main server configuration file is called `murmur.ini` (it can be renamed though).

You should find an example murmur.ini file alongside your installation, but you can also find the most recent **example file (with explanations) on [Github](https://github.com/mumble-voip/mumble/blob/master/scripts/murmur.ini)**.

Below is a list of the most important options:

`welcometext="Welcome on our Server!"` - the text will be send to every new user via chatmessage; if it's empty, no message will be send

`port=64738` - sets the port (see above); `64738` is the standard port

`serverpassword=` - sets the Serverpassword; if it's empty, users can connect without a password.

`bandwidth=72000` - sets the maximum bandwidth per user (in bits per second); setting it higher can increase the audio quality

`users=100` - sets the maximum number of online users

<!-- welcometext=
port=
serverpassword=
bandwidth=
users=
registerName= -->
`registerName=` - sets the Servername and the name of the main channel
toby63 marked this conversation as resolved.
Show resolved Hide resolved

For all available options, take a look at [Mumble Wiki - Murmur.ini](https://wiki.mumble.info/wiki/Murmur.ini).
For all available options and explanations, take a look at [Mumble Wiki - Murmur.ini](https://wiki.mumble.info/wiki/Murmur.ini).

## Administration with Mumble Client

Expand Down
64 changes: 43 additions & 21 deletions docs/user-guides/userguide_linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,20 @@ More information can be found in our [wiki](https://wiki.mumble.info/wiki/Instal
If you have installed Mumble through your distribution's repository, you should be able to find Mumble in your start menu.

Alternatively you can start it via a terminal.
The usual command is: `mumble`.
The usual command is:

```
mumble
```

Otherwise take a look at the package documentation of your distribution or the documentation for Flatpaks, Snapcraft etc.

On first start of Mumble, a short Settings wizard (for Audio settings, certificate creation etc.) will start automatically.
**Note:** On first start of Mumble, a short Settings wizard (for Audio settings, certificate generation etc.) will start automatically.

### Configuration

<!-- Short introduction or just link to the Client Config Guide? -->
Take a look at the [Client Configuration Guide](client_config_guide.md).
<!-- Are there differences between the OS versions? -->

## Mumble Server (Murmur)

Expand All @@ -42,7 +45,6 @@ The best option to install the Mumble Server (Murmur) is through your distributi
Just search for `Mumble Server` or `Murmur` in your package manager and install it.

Alternatively you can also find a **Static Linux Server** package on our [website](https://www.mumble.info/downloads/#manual-download).
<!-- Add a note that it contains outdated openssl? -->

### Configuration

Expand All @@ -57,45 +59,65 @@ The Mumble Server is either started [automatically](#auto-start) or [manually](#
On many distributions the Mumble Server is started automatically on system boot.

You can also disable this and start the Server manually.
Most distributions use `systemd` now, so search in the systemd documentation on how to disable the Mumble Server service.
Most distributions use `systemd` now, so search in the systemd documentation on how to disable the Mumble Server service (e.g. `murmur.service`).

Next Steps:

1. Set the SuperUser (Server Admin) password:

```
murmurd -ini /etc/murmur.ini -supw PASSWORD
```

2. Restart the Server:
If your system uses `systemd`, use e.g.:

```
systemctl restart murmur.service
```

3. Login & administrate the Server:
See [Server Configuration Guide](server_config_guide.md#administration-with-mumble-client) for details.

#### Manual Start

The Mumble Server should be run from the command line, so start a terminal.
(*If the `Static Linux Server` is installed or the binary is not linked, you have to change directory to wherever the Mumble Server is installed, first.*)
The Mumble Server should be run from a terminal.
(*If the `Static Linux Server` is installed or the binary is not linked, you have to change the directory to wherever the Mumble Server is installed, first.*)

Run the Mumble Server with:
<!-- Will the binary name change in 1.4? -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We currently don't have plans for that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remembered a discussion about the naming and now it is not planned anymore?
#4046

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It never was planned to rename the executable (afaik). This discussion was more referring to how the server should be referred to (in package archives).
@davidebeatrici did I misunderstand this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update: Binary names will probably be changed, see #4046.


<!-- Step by Step guide?:
1. Set Superuser password:
<!-- mention different binary name of static linux server? -->

1. Set the SuperUser (Server Admin) password:

```
murmurd [-supw <password>]
murmurd -supw <password>
```

2. Serverstart
Note: Flags are optional.
2. Start the server:

*Note:* Flags are optional (see below).
toby63 marked this conversation as resolved.
Show resolved Hide resolved
The standard configuration file used, is `murmur.ini` in the same directory.

```
murmurd
```

-->

<!-- Adjust descriptions? -->

**Flags:**

```
murmurd [-supw <password>] [-ini <inifile>] [-fg] [v]

-supw Set a new password for the SuperUser, which is the first Administrator of the Mumble Server. Keep this password safe. If you use this option, murmur will
set the password in the database and then exit.
-supw Set a new password for the SuperUser (Server Admin). Keep this password safe. Mumble Server will stop after this command.

-ini Use an inifile other than murmur.ini, use this to run several instances
of murmur from the same directory. Make sure each instance is using
a separate database.
-ini Use a specific inifile. You can also use this to run several instances
of murmur from the same directory. Make sure each instance is using a separate database.

-fg Run in the foreground, logging to standard output.

-v More verbose logging.
```

3. Login & administrate the Server:
See [Server Configuration Guide](server_config_guide.md#administration-with-mumble-client) for details.