-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Closed
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
5fec10d
DOCS: Added folder "user-guides" to the documentation.
toby63 c3943f9
DOCS: Added overlay.md to the User-Guides.
toby63 2e37b1a
DOCS: Added a seperate Server Configuration Guide to the User-Guides.
toby63 3592a68
MAINT: Added link to User-Guides to README.md and restructure.
toby63 6696119
update
toby63 76a594b
update
toby63 9e875c7
update
toby63 b38e4c8
update
toby63 86c5483
update
toby63 be2b3f8
update
toby63 4d8d8b6
update
toby63 e185698
update
toby63 a478d90
update; added pictures
toby63 d93b345
update
toby63 f226f03
update
toby63 c830116
update
toby63 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Userguides for Mumble | ||
|
||
The following Userguides include information on installation, configuration and starting of Mumble and the Mumble Server (murmur). | ||
|
||
Choose the specific guide for your operating system: | ||
|
||
- [Userguide for Windows](userguide_windows.md) | ||
- [Userguide for Linux/Unix](userguide_linux.md) | ||
- [Userguide for macOS](userguide_macos.md) | ||
|
||
**Additional Guides:** | ||
|
||
- [Client Configuration Guide](client_config_guide.md) | ||
|
||
- [Server Configuration Guide](server_config_guide.md) | ||
|
||
- [OpenGL Overlay](overlay_openGL.md): A Mumble overlay for Games and other applications. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
# Client Configuration Guide | ||
|
||
**Note:** For Installation and Starting of the Mumble Client, see the specific [Userguides](README.md) for your Operating System. | ||
|
||
<!-- Note: The pictures below are from a Mumble Client on Arch Linux, using the Dark Standard Theme, with already adjusted options. --> | ||
|
||
<!-- Todo --> | ||
<!-- | ||
|
||
- Add Troubleshooting section or seperate guide? | ||
|
||
- Pictures or even Gifs could be added for better presentation | ||
|
||
![Alt-Text](/Path/to/picture.jpg) | ||
Here should be a picture | ||
|
||
---> | ||
|
||
|
||
<!--## Audio Wizard? --> | ||
|
||
<!--## Important Config Options --> | ||
|
||
<!-- | ||
Topics suggested by Krzmbrzl: | ||
- change theme between Lite and Dark mode, | ||
- (done) echo cancellation, | ||
- (almost done)transmission modes (VAD, PTT, continous), | ||
- shortcuts | ||
|
||
--> | ||
|
||
## Configuration Menu | ||
|
||
Click on `Configure`->`Settings` or on the ![Gear symbol](https://github.com/mumble-voip/mumble-theme/blob/master/config_basic.png)-symbol to open the Configuration Menu. | ||
<!-- Gear symbol is too big; markdown option might not work with every parser; --> | ||
|
||
[Below](#most-important-options) you find a list with the most important options. | ||
|
||
*Tip: A small description of each option is displayed, when you hover your mouse pointer over it.* | ||
|
||
|
||
## Most important options | ||
|
||
### Audio Input | ||
|
||
![Here should be a picture](pictures/audio-input.png) | ||
|
||
#### Interface | ||
|
||
##### Echo Cancellation | ||
|
||
If enabled, this will filter echo from the audio you send to others. | ||
|
||
You should usually enable it, because even when you use headsets, they might transmit undesired noise. | ||
|
||
Choose one of the following options: | ||
|
||
| Option: | Description: | Usecases: | | ||
| --- | --- | --- | | ||
| Mixed echo cancellation | This is the basic Option: It will process all loudspeaker outputs bundled together. This is less accurate than the Multichannel option, but will also use less CPU. | Sufficient for setups with loudspeakers near to the microphone. | | ||
| Multichannel echo cancellation | Extended option: This will process all audio channels seperately, this is more accurate, but will result in higher CPU usage. | For setups with (multiple) loudspeakers farther away from the microphone. | | ||
| Disabled | Disables echo cancellation (not recommended). | - You use a very good headset. <br> - Or you use external echo cancellation (for example via pulseaudio on Linux). <br> - Echo cancellation is causing problems. | | ||
|
||
#### Transmission | ||
|
||
You can choose between three transmission modes: | ||
|
||
1. **Push to Talk** | ||
|
||
Your voice is only transmitted when you press a button. | ||
You can set the button in the `Shortcuts`-Menu (see below). | ||
|
||
![Here should be a picture](pictures/audio/push-to-talk.png) | ||
|
||
|
||
2. **Voice Activity** | ||
|
||
Your voice is only transmitted when a certain limit (loudness) is reached. | ||
All noise below the limit will be canceled. | ||
|
||
*Tip:* Use the `Audio Wizard`(`Configure`->`Audio Wizard`) to configure this option correctly. | ||
|
||
<!-- what is the difference between `Amplitude` and `Signal to noise` ? --> | ||
|
||
![Here should be a picture](pictures/audio/voice-activity.png) | ||
|
||
The coloured bar will show the noise-level when you speak, adjust `Silence below` (everything below the marker will not be transmitted) and `Speech above` (everything above the marker will be transmitted) accordingly. | ||
|
||
3. **Continuous** | ||
|
||
All Audio from your microphone will be transmitted continuously. | ||
|
||
**Note:** You should usually **not** use this option, as it can be very annoying for listeners. | ||
It is intended for special usecases (Music bots, Recording etc.) or when you use external tools for audio filtering instead. | ||
|
||
#### Compression | ||
|
||
| Option: | Description: | | ||
| --- | --- | | ||
| Quality | Sets the maximum bandwidth the client will try to accomplish (it is limited by the Server you are connected to). Setting it higher will increase the audio quality. Only set it higher if your internet connection is good enough. <!-- maximum? --> | | ||
| Audio per packet | <!-- What does it do? Which is option is better for which scenario? --> | | ||
|
||
#### Audio Processing | ||
|
||
**RNNoise** | ||
|
||
RNNoise is a noise suppression library. | ||
It is intended to filter background noises from the audio that you send sent to other users. | ||
RNNoise uses a deep learning algorithm so it should work better than most regular filters. | ||
|
||
More information can be found on various websites: | ||
|
||
- [RNNoise GitHub repo](https://github.com/xiph/rnnoise) | ||
- [Article at Mozilla.org on RNNoise](https://hacks.mozilla.org/2017/09/rnnoise-deep-learning-noise-suppression/) | ||
|
||
|
||
|
||
### Shortcuts | ||
|
||
![Here should be a picture](pictures/shortcuts.png) | ||
|
||
<!-- insert gif? --> | ||
|
||
|
||
### Overlay | ||
|
||
If enabled, it implements a small window inside other applications (mostly Games), that will show the users and their status in your Mumble channel. | ||
|
||
![Here should be a picture](pictures/overlay.png) | ||
|
||
| Tab: <!-- slider? --> | Description: | | ||
| --- | --- | | ||
| `Layout` | adjust the position of the window | | ||
| `Overlay Exceptions` | you can either specify a list of programs where the overlay is allowed (whitelist) or where the overlay is denied (blacklist). <!-- whitelist and blacklist are considered problematic nowadays, use alternatives? --> | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
### OpenGL Overlay | ||
|
||
<!-- Add a description --> | ||
|
||
The OpenGL overlay works by intercepting the call to switch buffers, and just before the buffer switch, we draw our nice GUI. | ||
|
||
To load a game with the overlay enabled, start the game like this: | ||
LD_PRELOAD=/path/to/libmumble.so.1.1 gamename | ||
|
||
If you have Mumble installed through the binary packages, this can be done by | ||
simply typing: | ||
mumble-overlay gamename |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# Server Configuration Guide | ||
|
||
**Note:** For Installation and Starting of the Mumble Server, see the specific [Userguides](README.md) for your Operating System. | ||
|
||
The Configuration involves three steps: | ||
|
||
1. [Network configuration](#network-configuration) | ||
2. [Main configuration file](#main-configuration-file) (`murmur.ini`) | ||
3. [Administration with Mumble Client](#administration-with-mumble-client) | ||
|
||
<!-- In addition there are some other interesting topics: | ||
|
||
- Bots (Music Bots) | ||
- Web interfaces (outdated) | ||
- gRPC (remote control) (buggy, not ready) | ||
- WebRTC bridge | ||
|
||
--> | ||
|
||
## Network Configuration | ||
|
||
### Static vs. dynamic IP | ||
|
||
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: 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:* | ||
|
||
* If your Mumble Server is running on a computer at your home, you will likely have a dynamic IP, thus you need a Dynamic DNS Service. | ||
* If your Mumble Server is running on a rented server at a Provider, you will in most cases have a static IP (already). | ||
|
||
#### Dynamic DNS Service | ||
|
||
A Dynamic DNS Service will give you a subdomain (e.g. `mymumbleserver123.dyndns-example.com`) and/or a static IP which your users can use to connect to your server. | ||
|
||
In the background the service will route them to your dynamic IP. | ||
A special software running on your computer will tell the service whenever your dynamic IP changes. | ||
|
||
For more information and a list of services and software, take a look at the [Arch Wiki - Dynamic DNS](https://wiki.archlinux.org/index.php/Dynamic_DNS) for example. | ||
|
||
### 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 standard port is `64738` (recommended). | ||
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 connections to the port for both protocols (TCP and UDP). | ||
|
||
Check and adjust your: | ||
|
||
- Computer's/Server's Firewall | ||
- (optional) Computer's Antivirus Program(s) | ||
- (for Home-Use) Router's Firewall | ||
|
||
<!-- more ports, for specific usecases? --> | ||
|
||
## Main configuration file | ||
|
||
The main server configuration file is called `murmur.ini` (it can be renamed though). | ||
|
||
You should find an example murmur.ini file in the program folders, but you can also look at the most recent **example murmur.ini (with explanations) on [Github](https://github.com/mumble-voip/mumble/blob/master/scripts/murmur.ini)**. | ||
|
||
Below is a list of the most important options: | ||
|
||
| Config Key: | Mandatory: | Default value: | Example: | Description: | Alternative(s): | | ||
| --- | --- | --- | --- | --- | --- | | ||
| welcometext= | no | - | "Welcome to our Server!" | the text will be send to every new user via chatmessage; if it's empty, no message will be send | welcometextfile= | | ||
| port= | yes | 64738 | - | sets the port (see above for details) | - | | ||
| serverpassword= | no | - | "supersecurepassword634%" | sets the Serverpassword; if it's empty, users can connect without a password. | - | | ||
| bandwidth= | yes | 72000 | - | sets the maximum bandwidth per user (in bits per second); setting it higher can increase the audio quality | - | | ||
| users= | yes | 100 | - | sets the maximum number of online users | - | | ||
| registerName= | no | - | "MyServer" | sets the Servername and the name of the main channel | - | | ||
| database= | no | empty (murmur.sqlite) | seconddatabase.sqlite | set this option, if you want to run multiple instances of murmur, so each instance has it's own database. Using sqlite is recommended. | Start multiple virtual servers (for now this is buggy (gRPC) or outdated (dbus; Ice)). See [Mumble Wiki - gRPC](https://wiki.mumble.info/wiki/GRPC) for details on setup etc. <!-- Ice and dbus [Mumble Wiki - Remote server control](https://wiki.mumble.info/wiki/Murmurguide#Remote_Controlling_the_Server) --> | | ||
|
||
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 | ||
|
||
- Use the Mumble client GUI for administration | ||
|
||
<!-- 1. Promote a normal User to be admin --> | ||
|
||
<!-- Channel creation, General Configuration, ACL and Groups --> | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that our shortcut menu currently is not the most intuitive thing to use, this might be a good idea 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will see how good or bad that will work :D.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did some testing with the gifs and right now it seems I am not able to make that work properly (filesizes to big, picture to small, quality to bad). Quess I do something wrong.
But I will keep trying; as an alternative I might just create a very short gif with the main steps (clicks) manually...