diff --git a/README.md b/README.md index a61380d0d67ad197e426306bcc158cff7993eaad..37961f893d5449fc3cbfae9cd8b7e012a7d0beb8 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,40 @@ # Build Mumble Web -A script to build the mumble-web app in a docker image. +You can use the `build_mumble_web.sh` script to build the mumble-web application, which +can be deployed with an webserver. The application +will be stored at `./dist`. The script will clone the [mumble-web](https://github.com/Johni0702/mumble-web) repository. If the repository already was cloned it will pull the latest commits. Afterwards the docker image, defined in the [Dockerfile](https://gitlab.cvh-server.de/aco/build-mumble-web/-/blob/master/Dockerfile), will be build. -**Dockerfile** +## build - - alpine:edge - - copy content of repository into image - - install git and npm - - npm: install, run build, audit fix, audit +To build the mumble-web application: just run the script! -The image contains the generated files of the app, which can be published by a webserver. -To copy these files out of the image it is necessary to create a container out of this image. -Therefore the command 'docker create' needs to be executed. -Afterwards the directory can be copied with 'docker cp'. - -The container and the image are not longer needed, so they will be removed at the end. - - -**Verifying commits** - -Commits made from the online editor are signed with the github web-flow key. -Other commits are not verified. - -[https://github.com/web-flow.gpg](https://github.com/web-flow.gpg) - - - -**Testing** +```bash +./build_mumble_web.sh +``` -To test if the generation of the website files was succesfully -a test version can be run with websockify. +## testing +If you want to test mumble web, you can deploy it together with mumble and websockify +via the provided 'docker-compose.yml' file. ``` -openssl req -newkey rsa:2048 -nodes -keyout test.key -x509 -days 365 -out test.crt -websockify --cert=test.crt --key=test.key --ssl-only --ssl-target --web=/home/node/dist 443 MUMBLE_SERVER:64738 +# to deploy run: +docker-compose up -d ``` +This will build two containers. One with mumble-web and nginx as a webserver and the second container +just contains websockify. The imae for the third container will not be build localy but +pulled from DockerHub. The container will serve murmur (mumble server) +for this test deployment. +The web application will be accessible via: [https://localhost](https://localhost). +The certificate is self signed, so your browser will warn you when you try to access the site. -**Deploy** -When the website is not deployed with websockify, it is still needed for the websocket. +**verifying the mumble-web repository** + +Commits made from the online editor are signed with the github web-flow key. +Other commits are not verified. -```websockify --ssl-target 64737 MUMBLE_SERVER:64738``` \ No newline at end of file +[https://github.com/web-flow.gpg](https://github.com/web-flow.gpg) \ No newline at end of file