Home

mumpeer is a small relay server for Mumcord's peer-to-peer features: screen sharing, camera sharing, full-size images, files and Mumcord plugin data. A Mumble community runs it next to its Mumble server, together with the relay bot mumbot peer. When two users cannot connect directly (NAT, carrier-grade NAT, strict firewalls) or a user wants to hide their IP address, both connect to the relay, and it forwards their end-to-end encrypted packets to each other.

• The Mumble server stays unmodified: no plugin, no config change.
• The relay cannot read what it forwards; it only sees encrypted bytes.
• It is not an open proxy: it forwards only between two users your bot paired, or from a sharer to the viewers your bot admitted to a broadcast.
• It is actively maintained: the current release is 0.3.0. See the changelog for what changed.

Start here

I want to …	Page
try it or set it up	Getting started
change ports, limits or the secret	Configuration
run it in production (systemd, Docker, port 443, logs)	Operating
know what it protects and what the operator sees, or report a vulnerability	Security and privacy
fix a problem	Troubleshooting
get a quick answer	FAQ

How the pieces fit

flowchart LR
    A["Mumcord A"] <-- "voice, chat, signalling" --> M["Mumble server<br/>(unmodified)"]
    Z["Mumcord B"] <-- "voice, chat, signalling" --> M
    B["mumbot peer"] <-- "announcement, tokens" --> M
    B -- "allowlist API (loopback)" --> R["mumpeer<br/>UDP + TCP 443"]
    A == "outer link (mTLS)" ==> R
    Z == "outer link (mTLS)" ==> R

Loading

1. The bot announces the relay (address, ports, certificate fingerprint) to Mumcord clients.
2. When two users need it, the bot asks mumpeer for a pair token and sends it to both.
3. Both connect to the relay with their Mumble certificate and the token.
4. The relay forwards their end-to-end encrypted packets, unchanged.

Reference documentation

The full documentation lives in the repository: operator guide · configuration reference · bot API · wire and handshake · troubleshooting · FAQ

Licence: AGPL-3.0. Sister projects: Mumcord (the client) and mumbot (bots, including the relay bot).