barbedfr/riot-web-docker
4
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
A docker image for a Matrix Riot.im web client
27 commits 1 branch 0 tags 45 KiB
Find a file
Exact
Antoine Mazeas 82992af430 upgrade alpine 3.22 
Signed-off-by: Antoine Mazeas <antoine@karthanis.net>
2025-10-25 18:44:07 +02:00
scripts Revert to https to fetch signing key 2021-04-27 11:34:42 +02:00
config.json Merge branch 'master' of ssh://code.barbed.fr:49003/barbedfr/riot-web-docker into master 2020-08-19 20:01:22 +02:00
Dockerfile upgrade alpine 3.22 2025-10-25 18:44:07 +02:00
LICENSE Initial commit 2018-04-01 13:41:35 +07:00
README.md Reduce size of resulting image by condensing install steps into shell script 2018-06-04 11:14:08 +07:00

README.md

riot-web-docker

A docker image for a Matrix Riot.im web client -- vector-im/riot-web.

This is a web client for Matrix. It's a bundle of static files destined to run on the client machine, so there is no need for a complicated web server installation to serve it.

The image exposes port 8080.

Building the image

Arguments:

It is generally OK to leave the defaults where they exist.

  • RIOT_VERSION (string): a valid release label found at vector-im/riot-web (example: v0.15.4).

  • SERVER_NAME (string): fully-qualified domain name of the machine which will serve the static files for the riot.im client. There is no default, hence you must provide a value here. The hostname must be resolvable over the intended network by all potential clients.

Note that a self-signed certificate (10 years validity) with CN=$SERVER_NAME will be created automatically. You should consider replacing with a real one, e.g. Let's Encrypt.

  • RIOT_USERNAME (string): the name of the system user that will run the static files web server serving the riot.im client. It will be created within the docker image. Default: matrix-riot-web

  • RIOT_GROUPNAME (string): the name of the system user group that will run the static files web server serving the riot.im client. Similarly, it will be created within the docker image. Default: matrix-riot-web

  • DEFAULT_HS_HOSTNAME (string): the full hostname of the default Matrix server the riot.im client should show when brought up on a user-agent. This is not the same as SERVER_NAME unless both riot.im and the Matrix server are hosted on the same host. Default: matrix.org

  • DEFAULT_HS_PORT (int): the port of the default Matrix server shown on this instance of riot.im. Default: 8448

Example build command:

This will create an image named image_name for a server url synapse_server_url and it will be tagged latest.

docker build --build-arg SERVER_NAME=<riot.im_server_name> --build-arg DEFAULT_HS_HOSTNAME=<myownmatrixserver.org> --build-arg RIOT_VERSION=<label_version> -t <image_name> .

Running

Exposed volumes:

  • /certs (certificates)

Exposed ports:

  • 8080/TCP

Example run command:

docker run -d -v riot-certs:/certs -p 8080:8080 <image_name>