Skip to content

tulir/mauliasproxy

Repository files navigation

Maunium Matrix room alias proxy

This is a simple room alias proxy that can respond to the federation alias query endpoint. The purpose is to allow creating room addresses with vanity domains without having to run a full-blown Matrix homeserver.

Discussion room: #maunium:mau.dev

Setup

You can either build the Go program yourself (just git clone + go build), or use the docker image dock.mau.dev/tulir/mauliasproxy.

After that, copy example-config.yaml to config.yaml and fill out the details you want. If using docker, mount the directory with config.yaml at /data.

Finally set up your reverse proxy to proxy /_matrix/federation/v1/query/directory on the alias domains to mauliasproxy.

Optionally, you may also proxy:

  • /.well-known/matrix/server to have mauliasproxy handle delegation to 443.
  • /_matrix/federation/v1/version and /_matrix/key/v2/server to make the federation tester pass.
    • To enable the key server endpoint, fill the server_keys section in the config.
  • /_matrix/federation/* to respond with a proper M_NOT_FOUND code to make old Synapses work.