Self-hosting WorkAdventure using Kubernetes Helm chart#

This Helm chart deploys Workadventure on Kubernetes.

Installation#

helm repo add workadventure https://charts.workadventu.re/
helm install workadventure workadventure/workadventure

Version numbering and upgrading#

Versions of the Helm chart are aligned with the versions of the WorkAdventure Docker image.
When a new version of the WorkAdventure Docker images are released, a new version of the Helm chart is released as well.

Configuration#

The chart is designed to work out of the box with the minimum required configuration.

The two compulsory parameters you need to provide are:

• the domainName parameter that should point to the domain name that will host WorkAdventure.
• the m̀apstorage.secretEnv.AUTHENTICATION_PASSWORD parameter that you should set to a password to access the map-storage container.

For each pod, there is a corresponding xxx.env entry in the values.yaml file (that will map to a ConfigMap),
and a xxx.secretEnv entry (that will map to a Secret). There are many pre initialized variables in the template files
(all variables relative to the URLs). Additional entries can be easily added in the corresponding
sections of the values file.

Furthermore, the commonEnv and commonSecretEnv sections can be used to add environment variables in all pods.

If you don't provide a secretKey (used to encode JWT tokens), the image will generate one for you.

Please use the original docker-compose file for reference. Look at the original configuration template for more information about the available variables.

Minimal sample configuration file#

Assuming you are using the nginx ingress controller, and CertManager for the SSL certificates (with a cluster issuer named letsencrypt-prod), here is a minimal configuration file:

values.yaml

domainName: example.com

singleDomain: true

ingress:
  enabled: true
  className: "nginx"
  tls: true
  secretName: "workadventure-cert"
  annotationsRoot:
    cert-manager.io/cluster-issuer: "letsencrypt-prod"
  annotationsPath:
    cert-manager.io/cluster-issuer: "letsencrypt-prod"

commonSecretEnv:
  # Secret token to connect to the map storage API.
  MAP_STORAGE_API_TOKEN: "123"

mapstorage:
  env:
    # Enable Bearer authentication for the map storage API so that we can connect using "npm run upload" in the map-starter-kit
    ENABLE_BEARER_AUTHENTICATION: "true"
  secretEnv:
    AUTHENTICATION_PASSWORD: "my-password"

Upload your map#

Before starting using WorkAdventure, you will need to upload your first map.

Uploading from the map starter kit#

Design your own map using the map starter kit.
When you are happy with the result, follow the steps in the "upload your map documentation"

With the sample installation above, the command to upload your map will look like this:

npm run upload -- -u https://example.com/map-storage/ -k 123

Checking everything worked#

Open your browser and go to https://<your-domain>/map-storage/ (or https://map-storage.<your-domain> if you are
using singleDomain: false in values.yaml).

You will be asked to authenticate. Use the credentials you configured in the .env file.

Note
Right now, authentication is limited to a single user credential in the map-storage container,
hard coded in the .env file. This is not ideal, but works for now (the map-storage container
is quite new). Contributions are welcome if you want to improve this.

You should see a link to the map you just uploaded.

Are you connected? Congratulations! Share the URL with your friends and start using WorkAdventure!