Mumble-Web
Related repo: https://gitlab.cvh-server.de/aco/cvh-olp
Mumble-Web ist ein Mumble-Client für den Webbrowser. Hiermit ist es möglich Mumble zu verwenden, ohne einen nativen Client installieren zu müssen.
Dieses Projekt ermöglicht es, die Javascript-Anwendung zu bauen, sodass sie mit einem Webserver ausgeliefert werden kann. Zum Bauen wird ein Docker-Container verwendet, sodass die benötigt Abhängigkeiten nicht auf dem ausführenden Hostsystem installiert sein müssen. Das Bauen kann, sowohl auf dem selben, als auch auf einem anderen Computer stattfinden.
build
Mit dem bereitgestellten Script build_mumble_web.sh kann die Anwendung gebaut werden.
Dazu führt das Script vollgende Schritte aus:
- Clonen des Mumble-Web Repositories: Falls nicht schon vorher geschehen, wird die aktuelle Version des Mumble-Web Repositories heruntergeladen. Wurde das Repository bereits heruntergeladen, wird es aktualisiert.
- Anschließend wird das im Dockerfile definierte Image
mumble-webgebaut. Das Image ist Alpine basiert und installiert nur die notwendigsten Pakete, um die Javascript-Anwendung zu bauen. - Um die Anwendung zu erhalten, die nach dem Erzeugen des Images sich in selbigem befindet, ist es notwendig einen Container auf Basis diese Image zu erzeugen.
- Aus dem erzeugten Container können anschließend die generierten Datein
zurück auf das Hostsystem kopiert werden.
Die kopierten Dateien liegen anschließend in dem Verzeichnis
./dist - Zuletzt werden sowohl der erzeugte Container, als auch das Image wieder entfernt, sodass bei einem wiederholten Bauen der Anwendung sichergestellt ist, dass alle Bestandteile aktualisiert werden.
Dockerfile
In dem Dockerfile
befinden sich neben dem mumble-web Image noch zwei weitere Images.
Bei dem zweiten Image handelt es sich um ein Image, dessen Basis bereits einen
Nginx-Webserver enthält.
In das Image werden die generierten Dateien aus dem mumble-web Image kopiert,
das zweite Image ist somit von dem ersten Image abhängig, weshalb es sich hierbei um
ein Multistage-Dockerfile handelt.
Dieses zweite Image wird dazu verwendet die Anwendung als eine Testversion bereitzustellen.
Das dritte Image, das in dem Dockerfile definiert ist basiert ebenfalls auf einem Alpine-Image.
Zusätzlich wird die Anwendung Websockify installiert, sie wird dazu benötigt
eine Verbindung zwischen einem Mumble-Server (Murmur) und der Webanwendung herzustellen.
testing
Um die Mumble-Web Anwendung zu testen kann sie lokal ausgeführt werden. Hierzu steht ein docker-compose Skript bereit, um alle notwendigen Container passend zu starten.
Das Script stellt einen eigenen Mumble-Server https://github.com/coppit/docker-mumble-server
bereit, dieser läuft auf dem Port 64738 und hat den Hostnamen murmur.
Damit der Server erfolgreich statet, muss die Konfigurationsdatei, die im Verzeichnis murmur liegt
vohanden sein. Dies ist der Fall, wenn docker-compose einfach im obersten Verzeichnis dieses
Repositories aufgerufen wird.
Damit der Web-Client sich mit Murmur verbinden wird ein Container mit Websockify benötigt, hierzu wird das Image verwendet, dass in dem beiligenden Dockerfile definiert ist. Das Image muss nicht selbständig gebaut werden, da dies docker-compose übernimmt. Websockify hört auf dem Port 64737 und leitet die Verbindungen an den Port 64738 zum Hostnamen murmur weiter.
Als letztes wird der Webserver gestartet.
Die Konfiguration für den Webserver liegt im Verzeichnis webserver
und wird beim starten des Containers eingebunden, so können Änderungen am Webserver
vorgenommen werde, ohne das Image neu erzeugen zu müssen.
In der vorliegenden Form verwendet der Webserver ein selbstsigniertes Zeritifikat, dass sich
im Verzeichnis webserver/certs befindet.
Bei Bedarf kann dieses dort ausgestauscht werden.
Die Konfiguration für nginx befindet sich im Verzeichnis webserver/conf.
Mit docker-compose können diese drei Container leicht ausgeführt werden:
# starten der Container
docker-compose up -d # baut die Images falls notwendig
# & startet die Container
# Ausgaben der Container können mit
docker-compose logs -f # abgerufen werden
# zum stoppen der Container reicht es
docker-compose down # auszuführen
Sind die Container gestartet kann Mumble-Web über https://localhost aufgerufen werden.
Wurde die Konfiguraiton von nginx nicht verändert, dann kann man sich mit der im Screenshot angezeigten Adresse sich mit dem Mumble-Server verbinden.
verifying the mumble-web repository
Commits made from the online editor are signed with the github web-flow key. Other commits are not verified.