Skip to main content

MumbleIce

This is a mumble bot for streaming audio from a Mumble room to Icecast.

Installing

Production (Docker)

The Docker image is recommended for running in production. The configuration file can be mounted to /mumbleice.yml or configuration can be done using environment variables. The file location can be changed with the MUMBLEICE_CONFIG_FILE environment variable.

All configuration options can be set using environment variables:

docker run -e MUMBLE_SERVER=mumble.server bitcast/mumbleice:dev

Environment Variables

  • MUMBLE_SERVER: The Mumble server to connect to.
  • MUMBLE_PORT: The port which the Mumble server uses. Defaults to 64738.
  • MUMBLE_USERNAME: The username for the bot on Mumble. Defaults to live-streamer.
  • MUMBLE_PASSWORD: The server password.
  • MUMBLE_CHANNEL: The Mumble channel to join. Defaults to Root.
  • MUMBLE_COMMAND_PREFIX: The command prefix that identifies commands to the bot. Defaults to !.
  • MUMBLE_MAX_SILENCE: The number of seconds of silence in Mumble required before the Icecast stream is disconnected. A value less than 0 implies that the connection will never be disconnected. Defaults to 30.
  • ICECAST_SERVER: The Icecast server to connect to.
  • ICECAST_PORT: The port which the Icecast server uses. Defaults to 8000.
  • ICECAST_USERNAME: The username to authenticate against Icecast with. Defaults to source.
  • ICECAST_PASSWORD: The password to authenticate against Icecast with. Defaults to hackme.
  • ICECAST_MOUNT_POINT: The mount point to use for streaming audio. Defaults to /mumble.
  • ICECAST_AUTOCONNECT: Automatically start streaming to Icecast once it is connected to Mumble. Defaults to false.

Development

Mumbleice requires Python 3.9 or later.

sudo apt install python3-dev python3-pip libopus0 virtualenv pre-commit
virtualenv -p python3 pyenv
pyenv/bin/pip install -e .
pre-commit install
cp mumbleice.yml.example mumbleice.yml
# Configure MumbleIce to connect to your mumble and Icecast servers
pyenv/bin/mumbleice -c mumbleice.yml

Metadata

Release files for mumbleice 1.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mumbleice 1.5.0
File Size Uploaded Provenance Actions
mumbleice-1.5.0.tar.gz 275.7 kB Without provenance Details for mumbleice-1.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mumbleice 1.5.0
File Interpreter ABI Platform Actions
mumbleice-1.5.0-py3-none-any.whl Python 3 none any Details for mumbleice-1.5.0-py3-none-any.whl

Total release size: 551.8 kB

Release files / mumbleice-1.5.0.tar.gz

Download URL mumbleice-1.5.0.tar.gz
Size 275.7 kB
Tags Source
SHA-256 checksum
How to use checksums
542e9adc9ed54f4614a2d4477849a5aa810431170bf36529b91268f08044d74d
BLAKE2b-256 checksum
How to use checksums
2115c97b33e8eb6f9c578ad8f8e9cb202fe637e91fe3a976f50013932b449d00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release files / mumbleice-1.5.0-py3-none-any.whl

Download URL mumbleice-1.5.0-py3-none-any.whl
Size 276.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5d1a3b83d248c706d58839799b5749764e0131707c803ae18b434cf819281459
BLAKE2b-256 checksum
How to use checksums
45158dcfd2818e47945f60759448c3babc8ec45c72a9bdff611edc70b2b9782c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Security for mumbleice 1.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page