bml-tg-notify/README.md

50 lines
2.1 KiB
Markdown
Raw Normal View History

2021-05-13 23:22:04 +05:00
# BML-TG-NOTIFY
2021-05-13 22:40:24 +05:00
## Push Notification BML Transcations to Telegram
2021-05-14 00:33:16 +05:00
![bml-notify-screenshot.jpg](bml-notify-screenshot.jpg)
2021-05-13 22:40:24 +05:00
2021-05-14 00:40:16 +05:00
## Is it safe?
- Probably, I will NOT take resposibilty to whatever you do with this script,
Understand how this works before proceeding. Your BML Username and Password will be saved in PLAIN TEXT!
2021-05-14 00:46:40 +05:00
Anyone who has access (or gains access) to your server or computer can read .env file and obtain your BML login credentials!
2021-05-13 22:57:53 +05:00
2021-05-14 00:40:16 +05:00
## Limitations
- At the moment this script can only check 1 account from personal profile.
2021-05-14 05:52:26 +05:00
- Script ONLY sends notification for last transaction, so if there more than 1 transacation
when script checks for new transactionsyou will get notification for the last one only.
2021-05-14 00:40:16 +05:00
### There's catch!
2021-05-14 05:36:04 +05:00
- BML do NOT allow you to be logged in more than 1 session at a time,
so when this script runs and if you were using mobile app or website you will be logged out!
You either get fast notification but with less time to use app
2021-05-13 23:22:04 +05:00
OR take as much as time you want to use app but slow notifications.
2021-05-14 05:36:04 +05:00
Which is why I have added a delay to change how often script logs into account,
This can be delay can be configured later.
2021-05-13 22:57:53 +05:00
2021-05-14 05:12:35 +05:00
## Getting started.
2021-05-14 00:37:26 +05:00
### Requriements
`curl` `jq`
- Install with whatever package manager you use.
- Make SURE they are installed before continuing!
2021-05-14 00:38:09 +05:00
### Download script and config
2021-05-13 22:40:24 +05:00
```
git clone https://github.com/shihaamabr/bml-tg-notify.git
cd bml-tg-notify
chmod +x bml-tg-notify.sh
2021-05-13 23:30:32 +05:00
cp env.sample .env
2021-05-13 22:40:24 +05:00
```
2021-05-14 05:13:05 +05:00
- Edit the contents of .env to your config (`nano .env`)
2021-05-14 05:12:35 +05:00
- [How to obtain BML_ACCOUNTID](https://raw.githubusercontent.com/shihaamabr/bml-tg-notify/main/how-to-obtain-BML_ACCOUNTID.png)
2021-05-14 00:46:40 +05:00
### Execute the script
2021-05-13 22:40:24 +05:00
```
./bml-tg-notify.sh
```
2021-05-14 05:12:35 +05:00
- Maybe run in a screen to run in background?
2021-05-14 05:52:26 +05:00
## Setting Delay - Optional
`echo XX > delay` where XX is the time in seconds you want to delay script logs into account
### Notes
- Default value is 160.
- If the XX value is less than a certain value (I think 15) your IP could get blocked by CloudFlare for DoS attack.
2021-05-14 05:12:35 +05:00
- You do not need to restart script after changing delay.
2021-05-14 05:52:26 +05:00
2021-05-14 00:40:16 +05:00
## Bugs
2021-05-14 04:16:34 +05:00
- [You tell me :)](https://github.com/shihaamabr/bml-tg-notify/issues/new)