https://github.com/fire1ce/udm-failover-telegram-notifications
UDMP Failover Telegram Notifications
https://github.com/fire1ce/udm-failover-telegram-notifications
Last synced: over 1 year ago
JSON representation
UDMP Failover Telegram Notifications
- Host: GitHub
- URL: https://github.com/fire1ce/udm-failover-telegram-notifications
- Owner: fire1ce
- Created: 2022-02-16T11:26:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T08:29:30.000Z (over 1 year ago)
- Last Synced: 2025-04-05T03:23:12.049Z (over 1 year ago)
- Language: Shell
- Size: 15.6 KB
- Stars: 7
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# UDM Failover Telegram Notifications
## Changelog
- 2023-02-22 - Added support for multiple UDM versions 1.x, 2.x and 3.x
## Persistence on Reboot
This script need to run every time the system is rebooted since the UDM overwrites crons every boot.
This can be accomplished with a boot script. Flow this guide: [UDM / UDMPro Boot Script](https://github.com/unifi-utilities/unifios-utilities/tree/main/on-boot-script)
## Compatibility
- Tested on [UDM PRO][amz-udm-pro-url]
## Installation
```bash
curl -s https://raw.githubusercontent.com/fire1ce/UDM-Failover-Telegram-Notifications/main/install.sh | sh
```
Set your Telegram Chat ID and Bot API Key at
$DATA_DIR for 1.x = /mnt/data
$DATA_DIR for 2.x and 3.x = /data
```bash
$DATA_DIR/UDMP-Failover-Telegram-Notifications/failover-notifications.sh
```
### Config
| Parameters | Description |
| ---------------------- | ----------------------------------------------------------------- |
| telegram_bot_API_Token | Telegram Bot API Token |
| telegram_chat_id | Chat ID of the Telegram Bot |
| echo_server_ip | IP of a server to test what interface is active (Default 1.1.1.1) |
| run_interval | Interval to run a failover check (Default 60 seconds) |
## Uninstall
Delete the **UDMP-Failover-Telegram-Notifications** folder
```bash
rm -rf $DATA_DIR/UDMP-Failover-Telegram-Notifications
```
Delete on boot script file
```bash
rm -rf $DATA_DIR/on_boot.d/99-failover-telegram-notifications.sh
```
## Usage
At boot the script with create a cronjob that will run once. This is done to prevent boot blocking.
Manual run to test notifications:
```bash
$DATA_DIR/UDMP-Failover-Telegram-Notifications/failover-notifications.sh
```
**It's strongly recommended to perform a reboot in order to check the on boot initialization of the notifications**
[amz-udm-pro-url]: https://amzn.to/3J4fezk 'Amazon Unifi UDM Pro'