https://github.com/losuler/asuswrt-update-notify
An update notification script for AsusWRT-Merlin.
https://github.com/losuler/asuswrt-update-notify
asuswrt-merlin notifications telegram
Last synced: 10 months ago
JSON representation
An update notification script for AsusWRT-Merlin.
- Host: GitHub
- URL: https://github.com/losuler/asuswrt-update-notify
- Owner: losuler
- License: gpl-2.0
- Created: 2020-02-24T18:26:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-13T00:09:47.000Z (over 4 years ago)
- Last Synced: 2025-02-08T22:07:07.185Z (over 1 year ago)
- Topics: asuswrt-merlin, notifications, telegram
- Language: Shell
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
AsusWRT Update Notify
Notifications for AsusWRT Merlin updates.
## About
An update notification script for [AsusWRT-Merlin](https://www.asuswrt-merlin.net/) based on the [example script](https://github.com/RMerl/asuswrt-merlin.ng/wiki/Update-Notification-Example), which is run when there is a new version ([checked every 48 hours at 2 am with a random offset](https://github.com/RMerl/asuswrt-merlin.ng/blob/f32e73d911c839ad43937e28003509e3c011ba75/release/src/router/rc/watchdog.c#L7017)).
## Configuration
Enable the service you would like to recieve notifications on (e.g. Telegram):
```sh
# Enable/Disable (Default: Disable)
TELEGRAM="enable"
```
### Telegram
`BOT_TOKEN`
This is the token for the bot. It is provided in the creation of a bot by following the steps provided in the [Telegram bot API documentation](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
`CHAT_ID`
This is the unique identifier for the target chat. It can be obtained by messaging the bot and executing the following command (replace `$BOT_TOKEN`). The ID may be found at `"chat": {"id": 12345678},`:
```sh
curl https://api.telegram.org/bot$BOT_TOKEN/getUpdates | python -m json.tool
```
### Matrix
`MATRIX_DOMAIN`
This is the domain for the Matrix server your room is hosted on. For most people this will likely be `matrix.org`.
`MATRIX_ROOM`
This is the internal room ID. The syntax is `!` followed by a random set of letters, for example `!abCDEfGhiJKLMnopQRs`. In Element you can find this by going to the room ➝ `Settings` ➝ `Advanced`.
`MATRIX_TOKEN`
This is the access token or secret that is used to authenticate the sending of the messages. You may retrieve this by either logging into Element through the browser or running the following command and copying the value from `access_token`:
```sh
curl -XPOST -d '{"type":"m.login.password", "user":"$USERNAME", "password":"$PASSWORD"}' \
"https://matrix.org/_matrix/client/r0/login"
```
## Installation
1. Copy `update-notification` into `/jffs/scripts/`. For example:
```sh
scp update-notification root@192.168.1.1:/jffs/scripts/
```
2. Apply execute permissions to the script.
```sh
chmod +x /jffs/scripts/update-notification
```