https://github.com/matrix-org/matrix-federation-tester
Tester for matrix federation written in golang.
https://github.com/matrix-org/matrix-federation-tester
Last synced: over 1 year ago
JSON representation
Tester for matrix federation written in golang.
- Host: GitHub
- URL: https://github.com/matrix-org/matrix-federation-tester
- Owner: matrix-org
- Created: 2016-10-24T14:30:35.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T21:41:45.000Z (over 1 year ago)
- Last Synced: 2025-03-29T20:06:14.400Z (over 1 year ago)
- Language: Go
- Size: 1.79 MB
- Stars: 89
- Watchers: 25
- Forks: 17
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Matrix Federation Tester
========================
Checks that federation is correctly configured on a matrix server.
Building
--------
Requires [Go](https://golang.org/) 1.18.
```bash
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:
```bash
BIND_ADDRESS=:8080 ./matrix-federation-tester
```
Alternatively, the federation tester can be used from the commandline via the
`-lookup` parameter:
```
./matrix-federation-tester -lookup
```
HTTP API
--------
The federation tester may be accessed using the following templated URLs. Please replace `` with your server name (eg: `matrix.org`).
**Full JSON report**
```
https://matrix.org/federationtester/api/report?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=
```