- Guide by Mr Swaggles
- Site design by ghostrider-05
- Webdev trickery by wejrox
Note
These steps will currently only work for the main rocketleaguemapmaking.com
domain. If you wish to view this branch or a PR remotely, visit the developer site or the subdomain in the PR actions.
This site can be executed as a docker container on the host machine.
To update the site on the host machine, run the deploy
workflow on the default branch with the following inputs:
- version: the version to deploy. Generally the same as the version in package.json.
- push (default:
true
). Controls whether to push the built image to Docker hub. Ifdeploy
is enabled andpush
is disabled, the server will use an already pushed image with the sameversion
, or fail. - deploy (default:
true
). Disable this to only build (and push) the Docker Image without deploying it. - webhook message (default:
true
): send a Discord message with the deployment details when the workflow is finished.
See the GitHub documentation for how to run a workflow manually.
Manual update steps
- Install Docker-CE on the host machine. Docker (non-ce) should also work but is not tested.
- Clone this repository.
- Build image not on host with
docker build . -t rocketleaguemapmaking/rlmm:<VERSION>
- Push to dockerhub with
docker login; docker push rocketleaguemapmaking/rlmm:<BUILD_VERSION>
- Navigate into the root of the repository on the host.
- Execute
sh deployment/update_and_deploy.sh <BUILD_VERSION>
, e.g.sh deployment/update_and_deploy.sh 0.1.0
on host- This container will run in the background, and you can access the website.
- To view all docker containers, execute
docker ps -a
, which are ordered by age. - To view the NGINX logs of a container, execute
docker logs <container_name>
. - To stop the service, execute
docker stop rlmm
- Execute
sh deployment/move_dummyassets.sh
to copy in the Not So Dummy Assets. - Access the site at the correct URL (
rocketleaguemapmaking.com
).
Read the contribution documentation for guidelines when contributing.
The certificate is renewed by the renewcert
script run using a cron job.