# 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:
```bash
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.
```bash
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/bitcastza/mumbleice",
"name": "mumbleice",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mumble audio icecast streaming",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/21/15/c97b33e8eb6f9c578ad8f8e9cb202fe637e91fe3a976f50013932b449d00/mumbleice-1.5.0.tar.gz",
"platform": null,
"description": "# MumbleIce\n\nThis is a mumble bot for streaming audio from a Mumble room to Icecast.\n\n# Installing\n\n## Production (Docker)\n\nThe Docker image is recommended for running in production. The configuration\nfile can be mounted to `/mumbleice.yml` or configuration can be done using\nenvironment variables. The file location can be changed with the\n`MUMBLEICE_CONFIG_FILE` environment variable.\n\nAll configuration options can be set using environment variables:\n\n```bash\ndocker run -e MUMBLE_SERVER=mumble.server bitcast/mumbleice:dev\n```\n\n### Environment Variables\n\n- **MUMBLE_SERVER**: The Mumble server to connect to.\n- **MUMBLE_PORT**: The port which the Mumble server uses. Defaults to `64738`.\n- **MUMBLE_USERNAME**: The username for the bot on Mumble. Defaults to\n `live-streamer`.\n- **MUMBLE_PASSWORD**: The server password.\n- **MUMBLE_CHANNEL**: The Mumble channel to join. Defaults to `Root`.\n- **MUMBLE_COMMAND_PREFIX**: The command prefix that identifies commands to the\n bot. Defaults to `!`.\n- **MUMBLE_MAX_SILENCE**: The number of seconds of silence in Mumble required\n before the Icecast stream is disconnected. A value less than 0 implies that\n the connection will never be disconnected. Defaults to `30`.\n- **ICECAST_SERVER**: The Icecast server to connect to.\n- **ICECAST_PORT**: The port which the Icecast server uses. Defaults to `8000`.\n- **ICECAST_USERNAME**: The username to authenticate against Icecast with.\n Defaults to `source`.\n- **ICECAST_PASSWORD**: The password to authenticate against Icecast with.\n Defaults to `hackme`.\n- **ICECAST_MOUNT_POINT**: The mount point to use for streaming audio. Defaults\n to `/mumble`.\n- **ICECAST_AUTOCONNECT**: Automatically start streaming to Icecast once it is\n connected to Mumble. Defaults to `false`.\n\n## Development\n\nMumbleice requires Python 3.9 or later.\n\n```bash\nsudo apt install python3-dev python3-pip libopus0 virtualenv pre-commit\nvirtualenv -p python3 pyenv\npyenv/bin/pip install -e .\npre-commit install\ncp mumbleice.yml.example mumbleice.yml\n# Configure MumbleIce to connect to your mumble and Icecast servers\npyenv/bin/mumbleice -c mumbleice.yml\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Mumble bot for streaming to Icecast",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/bitcastza/mumbleice"
},
"split_keywords": [
"mumble",
"audio",
"icecast",
"streaming"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "45158dcfd2818e47945f60759448c3babc8ec45c72a9bdff611edc70b2b9782c",
"md5": "e33f731c2ae51f59903cded5dc20c291",
"sha256": "5d1a3b83d248c706d58839799b5749764e0131707c803ae18b434cf819281459"
},
"downloads": -1,
"filename": "mumbleice-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e33f731c2ae51f59903cded5dc20c291",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 276118,
"upload_time": "2024-10-01T18:58:35",
"upload_time_iso_8601": "2024-10-01T18:58:35.621724Z",
"url": "https://files.pythonhosted.org/packages/45/15/8dcfd2818e47945f60759448c3babc8ec45c72a9bdff611edc70b2b9782c/mumbleice-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2115c97b33e8eb6f9c578ad8f8e9cb202fe637e91fe3a976f50013932b449d00",
"md5": "4b695d6831c394ff7ba9fd7df1cc5ad8",
"sha256": "542e9adc9ed54f4614a2d4477849a5aa810431170bf36529b91268f08044d74d"
},
"downloads": -1,
"filename": "mumbleice-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "4b695d6831c394ff7ba9fd7df1cc5ad8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 275703,
"upload_time": "2024-10-01T18:58:38",
"upload_time_iso_8601": "2024-10-01T18:58:38.201137Z",
"url": "https://files.pythonhosted.org/packages/21/15/c97b33e8eb6f9c578ad8f8e9cb202fe637e91fe3a976f50013932b449d00/mumbleice-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 18:58:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitcastza",
"github_project": "mumbleice",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ffmpeg-python",
"specs": []
},
{
"name": "pyaml-env",
"specs": []
},
{
"name": "pydub",
"specs": []
},
{
"name": "pymumble",
"specs": []
}
],
"lcname": "mumbleice"
}
JSON
