Matrix
Matrix is an open standard for decentralised, real-time communication. LinuxGSM uses the Matrix Client-Server API to send alerts to a room on any Matrix homeserver (matrix.org or self-hosted).
Create a room for alerts
Create a room for LinuxGSM to post alerts into using any Matrix client (e.g. Element).
Get your access token
An access token authenticates LinuxGSM as your Matrix account.
In Element: Settings > Help & About > Advanced > Access Token and click to reveal, then copy it.
Get the room ID
LinuxGSM needs the room's internal room ID, which starts with ! (e.g. !wsxanjDijPztgZgrYL:matrix.org).
Enable Matrix alerts
Turn on Matrix alerts and enter your details in the LinuxGSM config (~/lgsm/config-lgsm/<gameserver>/common.cfg).
matrixalert
Set to on to enable Matrix alerts.
matrixhomeserver
Your homeserver. A bare hostname is assumed to be https://; http:///https:// prefixes are respected.
matrixtoken
Your account access token.
matrixroom
The internal room ID (!...:server) to send alerts to.
Message format
Alerts are sent as notices with HTML formatting, so headings show in bold and links are clickable. Clients that do not render HTML show the same alert as plain text.
Testing the configuration
Execute a test alert with ./gameserver test-alert to verify the setup. If the alert appears in your Matrix room, the configuration is correct.
Last updated
Was this helpful?

