Skip to content

Commit 24f9dc6

Browse files
committed
docs: explain Transmission availability alerts
Document the outage threshold and one-shot recovery behavior. Closes #21
1 parent 621790f commit 24f9dc6

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ go install github.com/pyed/transmission-telegram/cmd/bot@latest
5757

5858
Explicit flags override the corresponding environment defaults. Prefer numeric Telegram user IDs for `-master`; unlike usernames, they cannot be renamed or reassigned.
5959

60+
### Transmission Availability Alerts
61+
62+
The RPC watcher reports an outage after three consecutive failed polls, avoiding alerts for brief connection interruptions. It sends only one warning per outage and one recovery message after the next successful poll.
63+
6064
### Example CLI Usage
6165

6266
Load `TT_BOT_TOKEN` and, when needed, `TR_AUTH` from a protected environment file, service manager, or secret store before starting the bot. Avoid passing tokens and passwords as command-line flags on shared systems because process arguments and shell history may expose them.

0 commit comments

Comments
 (0)