You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-11Lines changed: 32 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,8 @@ This Gotify plugin forwards all received messages to Telegram through the Telegr
16
16
17
17
4. Restart gotify.
18
18
19
+
5. Config the plugin.
20
+
19
21
***Build from source**
20
22
21
23
1. Change GOTIFY_VERSION in Makefile.
@@ -28,21 +30,40 @@ This Gotify plugin forwards all received messages to Telegram through the Telegr
28
30
29
31
3. Follow instructions from step 2 in the shared object installation.
30
32
33
+
## Configuration
34
+
35
+
The configuration contains three keys: `clients`, `gotify_host` and `token`.
36
+
37
+
### Clients
38
+
39
+
The `clients` configuration key describes which client(channel?) we are going to listen on and which telegram channel (and topic optionally!) we are forwarding the message to.
40
+
41
+
```yaml
42
+
clients:
43
+
- app_id: "The Gotify App ID to be matched. use -1 for all-matching."
44
+
telegram:
45
+
chat_id: "ID of the telegram chat"
46
+
token: "The bot token"
47
+
thread_id: "Thread ID of the telegram topic. Leave it empty if we are not sending to a topic."
48
+
- app_id: "Maybe the second Gotify Client Token, yay!"
49
+
telegram:
50
+
chat_id: "ID of the telegram chat"
51
+
token: "The bot token"
52
+
thread_id: "Thread ID of the telegram topic. Leave it empty if we are not sending to a topic."
53
+
```
54
+
55
+
### Gotify Host
56
+
57
+
The `gotify_host` configuration key should be set to `ws://YOUR_GOTIFY_IP` (depending on your setup, `ws://localhost:80` will likely work by default)
58
+
59
+
### Token
60
+
61
+
The `token` configuration key should be set to a valid token that can be created in the "Clients" tab.
62
+
31
63
## Troubleshooting
32
64
1. When only the Gotify dashboard receives your message, but not Telegram:
33
65
34
66
If, when making the API call to get your bot's chat ID, no data is returned, you may need to change the bot's privacy settings.
35
67
36
68
- In the BotFather chat, list your created bots and select the respective bot for which you want to change the Group Privacy setting.
37
69
- Turn off the Group Privacy setting.
38
-
39
-
## Appendix
40
-
Mandatory secrets.
41
-
42
-
```(shell)
43
-
GOTIFY_HOST=ws://YOUR_GOTIFY_IP (depending on your setup, "ws://localhost:80" will likely work by default)
44
-
GOTIFY_CLIENT_TOKEN=YOUR_CLIENT_TOKEN (create a new Client in Gotify and use the Token from there, or you can use an existing client)
45
-
TELEGRAM_CHAT_ID=YOUR_TELEGRAM_CHAT_ID (conversation ID from the Telegram API call above)
46
-
TELEGRAM_BOT_TOKEN=YOUR_TELEGRAM_BOT_TOKEN (API token provided by BotFather)
0 commit comments