Skip to content

Commit 2cbf45a

Browse files
Keithclaude
authored andcommitted
docs: add Matrix notification provider documentation
Add comprehensive documentation for Matrix notification setup including: - Account and room setup instructions - Access token generation guide - Configuration steps in Coolify - Troubleshooting common issues - Security information This documentation supports the Matrix notification feature added in coollabsio/coolify#6717 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 8201736 commit 2cbf45a

File tree

1 file changed

+58
-1
lines changed

1 file changed

+58
-1
lines changed

docs/knowledge-base/notifications.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Notifications"
3-
description: "Configure multi-channel notifications in Coolify with Email, Telegram, Discord, Slack, and Pushover for deployments, backups, and server monitoring alerts."
3+
description: "Configure multi-channel notifications in Coolify with Email, Telegram, Discord, Slack, Matrix, and Pushover for deployments, backups, and server monitoring alerts."
44
---
55

66
# Notifications
@@ -176,6 +176,63 @@ Email notifications can be configured using either SMTP or Resend.
176176
- Send a `Test notification`
177177

178178

179+
### Matrix
180+
181+
::: info
182+
Matrix is an open standard for decentralized, secure communication. Coolify supports sending notifications to Matrix rooms via the Matrix Client-Server API.
183+
:::
184+
185+
186+
1. Create or use a Matrix account
187+
- Create an account on any Matrix homeserver (e.g., [matrix.org](https://matrix.org), [element.io](https://element.io))
188+
- It's recommended to create a dedicated bot account for Coolify notifications
189+
190+
2. Create a Matrix room
191+
- Create a new room or use an existing room for Coolify notifications
192+
- Make sure your bot account is invited to the room
193+
194+
3. Get your Room ID
195+
- In your Matrix client (Element, FluffyChat, etc.), go to **Room Settings****Advanced**
196+
- Copy the **Internal room ID** (format: `!example:homeserver.com`)
197+
198+
4. Generate an Access Token
199+
- Use the Matrix login API to get an access token
200+
- Replace the values with your homeserver and bot credentials:
201+
202+
```bash
203+
curl -XPOST -H "Content-Type: application/json" -d '{
204+
"type": "m.login.password",
205+
"identifier": {"user": "@your_bot_username:homeserver.com", "type": "m.id.user"},
206+
"password": "your_bot_password"
207+
}' "https://homeserver.com/_matrix/client/v3/login"
208+
```
209+
210+
- Copy the `access_token` from the JSON response
211+
212+
::: info
213+
Store your access token securely. Anyone with access to it can send messages as your bot. Consider using Element's Settings → Help & About → Access Token for a simpler method.
214+
:::
215+
216+
5. Configure in Coolify
217+
- Go to **Notifications****Matrix**
218+
- Enter your `Homeserver URL` (e.g., `https://matrix.org`)
219+
- Enter the `Room ID` (e.g., `!example:matrix.org`)
220+
- Enter the `Access Token`
221+
- Optionally enter a `Friendly Name` for your configuration
222+
- Save the settings
223+
- Enable the Matrix channel
224+
- Send a `Test notification`
225+
226+
227+
::: info
228+
Common issues:
229+
- Ensure the bot account has permission to send messages in the room
230+
- Verify the Room ID format starts with `!` (e.g., `!roomname:homeserver.com`)
231+
- Check that your homeserver URL includes the protocol (`https://`)
232+
- Make sure the bot is not banned or restricted in the room
233+
:::
234+
235+
179236
### Pushover (Push Notifications)
180237

181238

0 commit comments

Comments
 (0)