Skip to content

Commit 3083ca9

Browse files
committed
readme: Clarify what WEBHOOK_URL_PATH actually does
1 parent a0ce5cc commit 3083ca9

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ MYSQL_SOCKET=/run/mysqld/mysqld.sock
88
MYSQL_DB=mydb
99
PRINT_MSGS=true
1010
PORT=
11-
WEBHOOK_PUBLIC_URL=
11+
WEBHOOK_PUBLIC_URL=https://example.com/webhook
1212
WEBHOOK_URL_PATH=/webhook
1313
WEBHOOK_SECRET=

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ Example with [Hookdeck](https://hookdeck.com/):
3333
1. Copy your `https://events.hookdeck.com/e/...` URL to `WEBHOOK_PUBLIC_URL` variable
3434
2. Set a webhook port (e.g. `41320`) to `PORT`
3535
3. Set `WEBHOOK_URL_PATH` to a custom path
36-
1. This is where the internal webhook server will listen on. Gotgbot **does not support an empty path** sadly.
37-
2. For Hookdeck, set "Destionation Type" to "CLI" and insert your path
38-
4. Use the Hookdeck CLI: `hookdeck listen 41320 [SOURCE]`
36+
- This is where the internal webhook server will listen on. Gotgbot **does not support an empty path**.
37+
- Remember to set the `WEBHOOK_PUBLIC_URL` to `https://.../WEBHOOK_URL_PATH`. This variable is the URL that is sent to Telegram to notify them to which URL to send their data. `WEBHOOK_URL_PATH` is not sent to Telegram, nor appended to the `WEBHOOK_PUBLIC_URL` internally! It's just used for the internal http server.
38+
- For Hookdeck, set "Destionation Type" to "CLI" and insert your path
39+
4. Use the Hookdeck CLI: `hookdeck listen 41320 [SOURCE]`. You can also use `cloudflared`, etc. It MUST be HTTPS!
3940

4041
### More options
4142

0 commit comments

Comments
 (0)