mirror of
https://github.com/matrix-org/matrix-federation-tester.git
synced 2026-11-17 03:51:00 +00:00
Tester for matrix federation written in golang.
- Go 96.1%
- Shell 3%
- Dockerfile 0.9%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
* 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> |
||
| .github | ||
| hooks | ||
| promutils | ||
| .gitignore | ||
| .golangci.yml | ||
| .travis.yml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
| README.md | ||
| run.sh | ||
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>