admin/Linux_post_install
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7dff27206b4f5aea009715e2075edb1b98edbe76
Linux_post_install/DOC/howto/communication.md
T

6.1 KiB
Raw Blame History

How-To: pos communication

Telegram messaging and alerts. Tools: telegram, matrix.

Tool What it does
pos communication telegram Send messages/files, manage config, webhook state, message logs
pos communication telegram listener Bot listener: map /command → bash and run it from chat (systemd user daemon)
pos communication matrix Matrix/Synapse sender (extensible; not yet implemented)

telegram is the workhorse: it backs the whole notify system — health digests, backup alerts, firewall changes — and can be used directly.

pos communication telegram

One-time setup

pos communication telegram config set TELEGRAM_BOT_TOKEN=123456:ABC...
pos communication telegram config set TELEGRAM_CHAT_ID=987654321
pos communication telegram config set TELEGRAM_DISABLE_WEBHOOK=true   # if used with webhooks
pos communication telegram config
# config lives in ~/.config/linux_post_install/telegram.env (chmod 600)

The bot token comes from @BotFather, the chat ID from @userinfobot (or by starting a chat and reading it). To set your display name once: message /start to your bot, then pos communication telegram chat-id prints it.

Send

pos communication telegram send "hello from my server"      # plain text
pos communication telegram send --markdown "**bold** ok"    # parse as markdown
pos communication telegram send --help                     # list all flags
pos communication telegram file /path/to/report.pdf         # send a document
pos communication telegram broadcast "restarting in 5min"   # to all known chat IDs

State & logs

pos communication telegram getwebhookinfo        # current webhook + pending count
pos communication telegram setwebhook https://... # point a webhook URL (or "")
pos communication telegram deletemenu            # clear the bot menu
pos communication telegram logs                  # recent send history (logs dir)
pos communication telegram clear-logs            # wipe message logs

Recipes:

  • Alert when a backup finishes — automatic: pos system backup calls notify_send (below) on success and failure.
  • Warn before a service update: 
    pos communication telegram send "Maintenance: docker compose down in 2min"
  • On-call file drop: pos communication telegram file ~/log/nginx-error.log

Troubleshooting:

  • "Not configured (no token or chat id)" → run config set for both values.
  • Send succeeds but nothing arrives → the chat must have started the bot (press Start / send /start once).
  • Markdown silently empty → Telegram uses its own MarkdownV2; unmatched syntax makes the message vanish. Use --markdown only when the text is Telegram-safe (the health digest output is).
  • Webhook vs getUpdates: if your bot has an active webhook, send may still work (we disable the webhook automatically when it owns it) — but if another process registered the webhook, polls fail; deletemenu/webhook state shows ownership. See getwebhookinfo.

pos communication telegram listener

Turns your bot into a two-way remote control: map /command → bash, then message the bot from your phone to run it.

pos communication telegram listener             # edit the /command → bash map
pos communication telegram listener --status    # service state + mapped commands
pos communication telegram listener --enable    # install the systemd user daemon
pos communication telegram listener --disable   # remove it
  • Map file: ~/.config/linux_post_install/telegram_commands.env (chmod 600), one /cmd=bash command per line — re-read on every message, so edits apply instantly. Example: 
    /status=@quiet pos system health --send
/temp=sensors | grep -i 'Tctl\|package id 0'
/update=cd /path/to/repo && git pull
  • Owner-only: the bot only reacts to TELEGRAM_CHAT_ID (your own chat); others are ignored. /help lists mapped commands; unknown → "Unknown command".
  • Runs as you: mapped commands execute as your user with a 60s timeout, stdout + stderr are replied to the chat (truncated ~3800 chars; empty → OK). sudo inside a command needs a NOPASSWD rule.
  • @quiet prefix: a map value starting with @quiet runs the command but does NOT reply — for commands that already send their own notification, so you don't get it twice. /status=@quiet pos system health --send delivers one digest via the notify system and nothing else.
  • Daemon lifecycle: the service is a systemd user unit; it stops at logout unless you enable linger: sudo loginctl enable-linger $(whoami). --enable prints this warning if linger is off.

Troubleshooting:

  • Bot doesn't answer → send /help; if silent, check the service with systemctl --user status pos-telegram-listener.service.
  • A webhook on the bot blocks getUpdates → delete it with pos communication telegram setwebhook "".
  • Needs jq (in preinstall PACKAGES).

The notify system (notify_send)

Every tool that announces something sends through lib/notify.sh instead of hard-coding Telegram:

# ~/.config/linux_post_install/notify.env
NOTIFY_PLATFORM=telegram        # default; comma-separated to fan out to all
  • notify_send "msg" → delivers to every platform in NOTIFY_PLATFORM (current senders: telegram).
  • Silent-fail: no platform configured → one WARN line, exit 0, never breaks the calling tool.
  • New platform (e.g. Matrix): implement bin/pos-communication-<p> send <value> [--markdown], then list it in NOTIFY_PLATFORM. Details: DOC/DEV.md → Alerting.

pos communication matrix

Sender contract exists (send <value> [--markdown]) and the dispatcher routes to it, but no implementation ships yet. When present, add matrix to NOTIFY_PLATFORM and configure it via pos communication matrix config set ….

Related

Reference in New Issue View Git Blame Copy Permalink