|
| 1 | +# MyTonCtrl Alert Bot |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +MyTonCtrl Alert Bot is a tool that allows you to receive notifications about the status of your node via Telegram Bot. |
| 6 | +It is a part of the MyTonCtrl toolset and is available for both validators and liteservers. |
| 7 | + |
| 8 | +## Setup |
| 9 | + |
| 10 | +To set up the MyTonCtrl Alerting Bot, follow these steps: |
| 11 | + |
| 12 | +### Prepare bot |
| 13 | + |
| 14 | +1. Go to https://t.me/BotFather and create bot using command `/newbot`. After that, you will receive a `BotToken`. |
| 15 | +2. Go to your bot and press the `Start` button. This will allow you to receive messages from the bot. |
| 16 | +3. If you want to receive messages from the bot in a group (chat), add the bot to the group and give it the necessary rights (make group admin). |
| 17 | +4. Go to https://t.me/getmyid_bot and press the `Start` button. It will reply you with your `ChatId`, use that if you want to receive messages directly to your Telegram account. |
| 18 | +If you want to receive messages in a group, add the bot to the group, and it will reply with the `ChatId` of the group. |
| 19 | + |
| 20 | +### Enable the Alert Bot |
| 21 | + |
| 22 | +1. Enable `alert-bot` via command |
| 23 | + |
| 24 | + ```bash |
| 25 | + MyTonCtrl> enable_mode alert-bot |
| 26 | + ``` |
| 27 | +2. Run command |
| 28 | + |
| 29 | + ```bash |
| 30 | + MyTonCtrl> set BotToken <BotToken> |
| 31 | + ``` |
| 32 | +3. Run command |
| 33 | + |
| 34 | + ```bash |
| 35 | + MyTonCtrl> set ChatId <ChatId> |
| 36 | + ``` |
| 37 | +4. Restart `mytoncore` service using command |
| 38 | + |
| 39 | + ```bash |
| 40 | + $ sudo systemctl restart mytoncore |
| 41 | + ``` |
| 42 | + |
| 43 | +## Supported Alerts |
| 44 | + |
| 45 | +The MyTonCtrl Alert Bot supports the following alerts: |
| 46 | + |
| 47 | +* Validator's wallet balance is low |
| 48 | +* Node's db usage is more than 80% |
| 49 | +* Node's db usage is more than 95% |
| 50 | +* Validator had low efficiency in the round |
| 51 | +* Node is out of sync |
| 52 | +* Node is not running (service is down) |
| 53 | +* Node is not answering to ADNL connection |
| 54 | +* Validator created zero blocks for past 6 hours |
| 55 | +* Validator has been slashed in the previous validation round |
0 commit comments