mirror of
https://github.com/matrix-org/matrix-federation-tester.git
synced 2025-04-19 07:02:19 +03:00
Update to a more recent version of gomatrixserverlib, mostly to pick up the fix to matrix-org/gomatrixserverlib#440. Since GMSL now requires go 1.18, bump to that. Fixes #153.
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>
Description
Languages
Go
96%
Shell
3%
Dockerfile
1%