https://github.com/ppfeufer/aa-mumble-quick-connect
https://github.com/ppfeufer/aa-mumble-quick-connect
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ppfeufer/aa-mumble-quick-connect
- Owner: ppfeufer
- License: gpl-3.0
- Created: 2025-02-12T19:11:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-01T12:23:42.000Z (12 months ago)
- Last Synced: 2025-07-05T08:42:02.457Z (11 months ago)
- Language: Python
- Size: 457 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# AA Mumble Quick Connect
[](https://pypi.org/project/aa-mumble-quick-connect/)
[](https://github.com/ppfeufer/aa-mumble-quick-connect/blob/master/LICENSE)
[](https://pypi.org/project/aa-mumble-quick-connect/)
[](https://pypi.org/project/aa-mumble-quick-connect/)
[](https://results.pre-commit.ci/latest/github/ppfeufer/aa-mumble-quick-connect/master)
[](http://black.readthedocs.io/en/latest/)
[](https://discord.gg/zmh52wnfvM)
[](https://github.com/ppfeufer/aa-mumble-quick-connect/actions/workflows/automated-checks.yml)
[](https://codecov.io/gh/ppfeufer/aa-mumble-quick-connect)
[](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)
[](https://github.com/ppfeufer/aa-mumble-quick-connect/blob/master/CODE_OF_CONDUCT.md)
[](https://ko-fi.com/N4N8CL1BY)
App for Alliance Auth to provide quick connect links for Mumble channels.
______________________________________________________________________
- [Screenshots](#screenshots)
- [Mumble Quick Connect](#mumble-quick-connect)
- [Installation](#installation)
- [Bare Metal Installation](#bare-metal-installation)
- [Step 1: Install the App](#step-1-install-the-app)
- [Step 2: Update Your AA Settings](#step-2-update-your-aa-settings)
- [Step 3: Finalizing the Installation](#step-3-finalizing-the-installation)
- [Docker Installation](#docker-installation)
- [Step 1: Add the App](#step-1-add-the-app)
- [Step 2: Update Your AA Settings](#step-2-update-your-aa-settings-1)
- [Step 3: Build Auth and Restart Your Containers](#step-3-build-auth-and-restart-your-containers)
- [Step 4: Finalizing the Installation](#step-4-finalizing-the-installation)
- [Permissions](#permissions)
- [Changelog](#changelog)
- [Translation Status](#translation-status)
- [Contributing](#contributing)
______________________________________________________________________
> [!NOTE]
>
> To use this app, you need to have [Alliance Auth](https://gitlab.com/allianceauth/allianceauth) installed, and the [Mumble Service](https://allianceauth.readthedocs.io/en/latest/features/services/mumble.html) enabled.
Install the app using pip:
```shell
pip install aa-mumble-quick-connect
```
#### Step 2: Update Your AA Settings
Add the app to your `INSTALLED_APPS` in your `local.py`:
```python
INSTALLED_APPS += [
"aa_mumble_quick_connect", # https://github.com/ppfeufer/aa-mumble-quick-connect
]
```
#### Step 3: Finalizing the Installation
Copy static files and run migrations
```shell
python manage.py migrate mumble_quick_connect
python manage.py collectstatic --noinput
```
Add the app to your `conf/requirements.txt`:
```text
aa-mumble-quick-connect==0.0.10
```
#### Step 2: Update Your AA Settings
Add the app to your `INSTALLED_APPS` in your `conf/local.py`:
```python
INSTALLED_APPS += [
"aa_mumble_quick_connect", # https://github.com/ppfeufer/aa-mumble-quick-connect
]
```
#### Step 3: Build Auth and Restart Your Containers
```shell
docker compose build --no-cache
docker compose --env-file=.env up -d
```
#### Step 4: Finalizing the Installation
Copy static files and run migrations
```shell
docker compose exec allianceauth_gunicorn bash
auth collectstatic
auth migrate
```
The app comes with a default permission `aa_mumble_quick_connect | general | Can access this app` that allows
users to view the Mumble Quick Connect page.
See [CHANGELOG.md](https://github.com/ppfeufer/aa-mumble-quick-connect/blob/master/CHANGELOG.md) for a list of changes.
[](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)
Do you want to help translate this app into your language or improve the existing
translation? - [Join our team of translators][weblate engage]!
Do you want to contribute to this project? That's cool!
Please make sure to read the [Contribution Guidelines](https://github.com/ppfeufer/aa-mumble-quick-connect/blob/master/CONTRIBUTING.md).\
(I promise, it's not much, just some basics)
[weblate engage]: https://weblate.ppfeufer.de/engage/alliance-auth-apps/ "Weblate Translations"