Merge branch 'main' into additional-config-options

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+---
+name: "Mumble pull request template"
+about: "Mumble pull request template"
+---
+
+<!--
+Thank you for doing recipe maintenance work!
+Please mark all checklist items which are relevant for your changes.
+Please remove the checklist items which are not relevant for your changes.
+Feel free to remove this comment.
+-->
+
+* [ ] I have deployed and tested my changes
+* [ ] I have [updated relevant versions in `abra.sh`](https://docs.coopcloud.tech/maintainers/upgrade/#updating-versions-in-the-abrash)
+* [ ] I have made my environment variable changes [backwards compatible](https://docs.coopcloud.tech/maintainers/upgrade/#backwards-compatible-environment-variable-changes)
+* [ ] I have added a [release note entry](https://docs.coopcloud.tech/maintainers/upgrade/#creating-new-release-notes)

MAINTENANCE.md

@@ -0,0 +1,31 @@
+# Traefik Recipe Maintenance
+
+All contributions should be made via a pull request. This is to ensure a
+certain quality and consistency, that others can rely on.
+
+## Maintainer Responsibilities
+
+A recipe maintainer has the following responsibilities:
+
+- Respond to pull requests / issues within a week
+- Make image security updates within a day
+- Make image patch / minor updates within a week
+- Make image major updates within a month
+
+In order to fullfill these responsibilities a recipe maintainer:
+
+- Has to watch the repository (to get notifications)
+- Needs to make sure renovate is configured properly
+
+## Pull Requests
+
+A pull request can be merged if it is approved by at least one maintainer. Even though it is okay to merge a pull request with one approval, it is always better if all maintainers looked at the pull request and approved it.
+
+Pull requests opened by a maintainer need to be approved by another maintainer. If there is only one maintainer, reviews from operators are recommended but not required.
+
+## Become a maintainer
+
+Everyone can apply to be a recipe maintainer:
+1. Watch the repository to always get updates
+2. Add your self to the list in the [README.md](./README.md) and open a new pull request with the change.
+3. Once the pull request gets merged you will be added to the [mumble maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/mumble-maintainers).

README.md

@@ -21,14 +21,35 @@ Low latency, high quality voice chat application.
 ## Basic usage
 
 1. Set up Docker Swarm and [`abra`]
-2. Deploy [`coop-cloud/traefik`]
+2. Configure [`coop-cloud/traefik`] to accept mumble's ports:
-3. `abra app new ${REPO_NAME} --secrets` (optionally with `--pass` if you'd like
+    ```bash
-   to save secrets in `pass`)
+    $ abra app config <YOURTRAEFIKDOMAIN>
-4. `abra app config YOURAPPDOMAIN` - be sure to change `$DOMAIN` to something that resolves to
+    ```
-   your Docker swarm box
+  - uncomment lines related to mumble:
-5. `abra app deploy YOURAPPDOMAIN`
+    ```
-6. Open the configured domain in your browser to finish set-up
+    COMPOSE_FILE="$COMPOSE_FILE:compose.mumble.yml"
+    MUMBLE_ENABLED=1
+    ```
+  - save the config and deploy traefik:
+    ```bash
+    $ abra app deploy <YOURTRAEFIKCOMAIN> --force
+    ```
+3. `abra app new mumble`
+4. `abra app config <YOURAPPDOMAIN>`
+5. `abra app deploy <YOURAPPDOMAIN>`
+6. Connect with a [Mumble client] to port 64738 on your domain
+
+## Web Client
+
+An optional browser-based client is available via the `compose.mumbleweb.yml`
+overlay. To enable it:
+1. `abra app config mumble.example.com` — uncomment the line:
+   ```
+   COMPOSE_FILE="$COMPOSE_FILE:compose.mumbleweb.yml"
+   ```
+2. `abra app deploy <YOURAPPDOMAIN> --force`
+3. Open `https://<YOURAPPDOMAIN>` in a browser
 
 [`abra`]: https://git.coopcloud.tech/coop-cloud/abra
 [`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
-coop-cloud/traefik
+[Mumble client]:(https://www.mumble.info/downloads/)