Skip to content

docs(telegram): document optional SOCKS5 notification proxy #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mdktdys wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(telegram): document optional SOCKS5 notification proxy #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions apps/docs/content/docs/core/(Notifications)/telegram.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ For start receiving telegram notifications, you need to fill the form with the f
- **Name**: Enter any name you want.
- **Bot Token**: Enter the bot token. eg. `123456789:ABCdefGHIjklMNOPqrstUVWXYZ`
- **Chat ID**: Enter the chat ID. eg. `123456789`
- **SOCKS5 Proxy URL** (optional): Route Telegram notifications through a SOCKS5 proxy. Leave this field empty to connect directly.

To Setup the telegram notifications, follow these steps:

Expand All @@ -26,3 +27,11 @@ To Setup the telegram notifications, follow these steps:
8. Copy the `Chat ID` and paste it in Dokploy `Telegram` Modal section.
9. Click on test to make sure everything is working.
10. Click on `Create` to save the notification.

## SOCKS5 Proxy

If your Dokploy server cannot reach Telegram directly, enter a `socks5://` or `socks5h://` URL in **SOCKS5 Proxy URL**, for example `socks5://proxy.example.com:1080`. Both schemes resolve Telegram's hostname through the proxy. The port defaults to `1080` when omitted.

For a proxy that requires authentication, include the username and password in the URL: `socks5://username:password@proxy.example.com:1080`. Percent-encode special characters in the username and password; for example, the password `p@ss` becomes `p%40ss`.

Click **Test Notification** to verify delivery through the configured proxy before saving. The test uses the same proxy as Telegram notifications. Clear **SOCKS5 Proxy URL** and save to restore direct connections.