Tester for matrix federation written in golang.
  • Go 96.1%
  • Shell 3%
  • Dockerfile 0.9%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Travis Ralston 160fac693f
Support MSC4040 matrix-fed service name lookup (#142)
* Support MSC4040 `matrix-fed` service name lookup

* Fix SRV error handling to ensure non-8448 addresses get added

* Code to support upgrade to gomatrixserverlib

* Re-add non-dependency

* Remove debug comment.

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>

---------

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Richard van der Hoff <richard@matrix.org>
2026-06-01 10:45:32 +01:00
.github Update gomatrixserverlib version (#155) 2024-11-12 11:05:10 +00:00
hooks Travis config 2019-02-10 21:10:02 +00:00
promutils Update golangci-lint config (#154) 2024-11-06 14:37:58 +00:00
.gitignore Use go modules instead of gb (#46) 2019-03-26 17:43:10 +00:00
.golangci.yml Update golangci-lint config (#154) 2024-11-06 14:37:58 +00:00
.travis.yml Add support for TLSv1.3 (#100) 2020-07-21 13:29:08 +01:00
Dockerfile Build the Docker image with Go 1.19 2022-09-01 11:09:11 +01:00
go.mod Update gomatrixserverlib version (#155) 2024-11-12 11:05:10 +00:00
go.sum Update gomatrixserverlib version (#155) 2024-11-12 11:05:10 +00:00
main.go Support MSC4040 matrix-fed service name lookup (#142) 2026-06-01 10:45:32 +01:00
README.md Update gomatrixserverlib version (#155) 2024-11-12 11:05:10 +00:00
run.sh Add support for TLSv1.3 (#100) 2020-07-21 13:29:08 +01:00

Matrix Federation Tester

Checks that federation is correctly configured on a matrix server.

Building

Requires Go 1.18.

git clone https://github.com/matrix-org/matrix-federation-tester
cd matrix-federation-tester
go build

Running

An HTTP daemon can be started as follows:

BIND_ADDRESS=:8080 ./matrix-federation-tester

Alternatively, the federation tester can be used from the commandline via the -lookup parameter:

./matrix-federation-tester -lookup <server_name>

HTTP API

The federation tester may be accessed using the following templated URLs. Please replace <server_name> with your server name (eg: matrix.org).

Full JSON report

https://matrix.org/federationtester/api/report?server_name=<server_name>

Plain text response

Returns GOOD if the federation is ok and BAD if it's not ok.

https://matrix.org/federationtester/api/federation-ok?server_name=<server_name>