• Stars
    star
    263
  • Rank 155,624 (Top 4 %)
  • Language
    Go
  • License
    Other
  • Created about 14 years ago
  • Updated over 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Alternative Mumble server

Linux CI (Travis CI):

Build Status

Windows CI (AppVeyor):

Build status

Go:

Go Report Card

What is Grumble?

Grumble is an implementation of a server for the Mumble voice chat system. It is an alternative to Murmur, the typical Mumble server.

Compiling Grumble from source

You must have a Go 1 environment installed to build Grumble. Those are available at:

https://golang.org/dl/

Once Go is installed, you should set up a GOPATH to avoid clobbering your Go environment's root directory with third party packages.

Set up a GOPATH. On Unix, do something like this

$ export GOPATH=$HOME/gocode
$ mkdir -p $GOPATH

and on Windows, do something like this (for cmd.exe):

c:\> set GOPATH=%USERPROFILE%\gocode
c:\> mkdir %GOPATH%

Then, it's time to install Grumble. The following line should do the trick:

$ go get mumble.info/grumble/cmd/grumble

And that should be it. Grumble has been built, and is available in $GOPATH/bin as 'grumble'.

Project status

Grumble is pretty much feature complete, except for a few "minor" things.

There is no bandwidth limiting, and there is no API to remote control it.

Grumble's persistence layer is very ad-hoc. It uses an append-only file to store delta updates to each server's internal data, and periodically, it syncs a server's full data to disk.

Grumble is currently architected to have all data in memory. That means it's not ideal for use with very very large servers. (And large servers in this context are servers with many registered users, ACLs, etc.).

It is architected this way because it allowed me to write a pure-Go program with very few external dependencies, back 4-5 years ago.

The current thinking is that if registered users are taking up too much of your memory, you should use an external authenticator. But that code isn't written yet. The concept would be equivalent to Murmur's authenticator API via RPC. But a Grumble authenticator would probably be set up more akin to a webhook -- so just a URL in the config file.

Then there's the API problem. You can't currently remote control Grumble. Which can make it hard to use in production. I imagine Grumble will grow an API that it makes available via HTTP. Murmur's API is already quite stateless in many regards, so it shouldn't be too much of a stretch to put a RESTful API in Grumble to do the same job.

Docker

Getting the image

Building

$ git clone https://github.com/mumble-voip/grumble.git
$ cd grumble/
$ docker build -t mumble-voip/grumble .

Running

Command line

$ docker run \
  -v $HOME/.grumble:/data \
  -p 64738:64738 \
  -p 64738:64738/udp \
  mumble-voip/grumble

Compose

version: '3'
services:
  grumble:
    image: mumble-voip/grumble
    ports:
      - 64738:64738
      - 64738:64738/udp
    volumes:
      - $HOME/.grumble:/data

More Repositories

1

mumble

Mumble is an open-source, low-latency, high quality voice chat software.
C++
5,598
star
2

mumble-iphoneos

Mumble client for iOS-based devices
Objective-C
188
star
3

mumblekit

Objective-C-based Mumble client framework for iOS and Mac OS X
Objective-C
153
star
4

mumo

Mumble Moderator framework simplifying development of plugins that connect to Mumble servers via Ice. (handles basic ICE connectivity, contains basic module loading and message multiplexing)
Python
50
star
5

mumble-scripts

Mumble scripts is a place for gathering various scripts written for the Mumble VoIP application.
Python
48
star
6

libmumble-legacy

libmumble is an attempt at writing a cross-platform C++ library for implementing Mumble clients
Assembly
37
star
7

mumble-protocol

Mumble protocol documentation
Makefile
31
star
8

mumble-releng

Mumble Release Engineering
Python
18
star
9

libmumble

C++17 Mumble library.
C++
15
star
10

mumble-docker

Docker support for Mumble
Shell
14
star
11

mumble-www

The Mumble website
HTML
12
star
12

mumble-pahelper

C++
8
star
13

mumble-plugin-cpp

A C++ wrapper for around the C plugin interface that was introduced with Mumble 1.4.0
C++
8
star
14

mumble-ubuntu-ppa

Template Debian package used to generate the Mumble team's PPAs on Launchpad.
Shell
7
star
15

mumble-json-bridge

A Mumble plugin that offers a JSON API for Mumble interaction via named pipes
C++
6
star
16

celt-0.11.0

The Mumble team's CELT 0.11.0 repository.
C
5
star
17

celt-0.7.0

The Mumble team's CELT 0.7.0 repository.
C
4
star
18

mumble-gpg-signatures

GPG signatures for Mumble
4
star
19

libcrossaudio

C11 audio library.
C++
4
star
20

mumble-developers-qt

The Mumble developers's Qt 4 tree
C++
3
star
21

speex

Mumble's mirror of Speex. Used for Mumble's Speex submodule.
C
3
star
22

mach_override

The Mumble team's mirror of the mach_override Git repo (https://github.com/rentzsch/mach_override)
C
2
star
23

.github

2
star
24

mumble-streamdeck-integration

A plugin for integrating the Mumble client with Elgato's Stream Deck
CSS
2
star
25

speexdsp

Mumble's mirror of SpeexDSP. Used for Mumble's SpeexDSP submodule.
C
2
star
26

libmumble-gyp

A clone of gyp with minor patches needed to build libmumble on certain platforms.
Python
2
star
27

crypto-benchmark

libhydrogen/libsodium/NSS/OpenSSL/wolfCrypt benchmark, used to determine the best cipher and library for Mumble.
C
2
star
28

cygwin-bootstrap

Cygwin bootstrapper for mumble-releng
Go
1
star
29

sbcelt

A sandboxed CELT 0.7 decoder library (API compatible) for Linux, FreeBSD and Mac OS X (for now...)
C
1
star
30

fx11

Git mirror for Effects 11 β€œfx11” - MS-PL - from https://fx11.codeplex.com/
C++
1
star
31

mumble-plugin-template

A template for getting started writing Mumble plugins using the standard C API.
C
1
star
32

mumble-releng-vcpkg

Mumble build environment preparer, uses vcpkg - for Mumble version >= 1.4
Shell
1
star
33

qt_unicode_test

Source for upstream Qt bug report (minimal example for reproduction)
C++
1
star
34

MumbleTransifexBot

Pulls updated translations from transifex and if anything relevant changed creates a pull request with the translation update to the mumble master repository
Python
1
star
35

backend-services

Scripts used to power the Mumble public infrastructure backend (e.g. public server list)
Lua
1
star