Skip to content
A static golang generated preview of public world readable Matrix rooms.
Branch: master
Clone or download
Latest commit 66ec203 May 7, 2019

Matrix Static


git clone or download this repository as an archive and extract then follow below instructions.

go get
go get
gb build

After this, executables will be in the bin directory.


First you must create a config, there is a sample json file provided or you can use the helper binary register-guest to register a guest on a given homeserver and write an appropriate config file.

register-guest takes the following options:

--config-file= to specify the config file, defaulting to ./config.json.

--homeserver-url= to specify the Homeserver URL to use, defaulting to

The main binary, matrix-static exhibits the following controls:

Accepts PORT= env variable to determine what port to use, defaulting to port 8000 if one is not specified. Will panic if port is in use.

Accepts the following command line arguments:

--config-file= to specify the config file, defaulting to ./config.json.

--enable-pprof if set, enables the /debug/pprof endpoints for debugging.

--enable-prometheus-metrics if set, enables the /metrics endpoint for metrics.

--num-workers= to specify the number of worker goroutines to start, defaults to 32

--public-serve-prefix= to specify the router prefix to use for the user-facing html-serving routes, defaults to /


Currently hosted at

Discussion Matrix Room is

You can’t perform that action at this time.