https://github.com/adarshb2000/flask-telegram-logger
A simple flask api that updates (logs) to user with a given user ID.
https://github.com/adarshb2000/flask-telegram-logger
Last synced: 12 months ago
JSON representation
A simple flask api that updates (logs) to user with a given user ID.
- Host: GitHub
- URL: https://github.com/adarshb2000/flask-telegram-logger
- Owner: Adarshb2000
- License: mit
- Created: 2024-08-24T06:37:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T07:40:10.000Z (almost 2 years ago)
- Last Synced: 2024-08-24T08:40:36.480Z (almost 2 years ago)
- Language: Python
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flask Telegram Logger
A simple flask api that updates (logs) to user with a given user ID.
### Installation
#### With Docker
- pull docker image `adarshbaderia/flask-telegram-logger`
- run with command `docker run -d -p 8353:8353 -e TELEGRAM_TOKEN={YOUR_BOT_TOKEN_GOES_HERE} -e USER_ID={YOUR_TELEGRAM_USER_ID_GOES_HERE} adarshbadera/flask-telegram/logger`
#### Running Script
- Add `TELEGRAM_TOKEN` and `USER_ID` to your env variables.
- run the script.
### Usage
- Depending on how you configure this, call the API `http://{YOUR_LAN_IP}:8353/update with message in request body to send the request body to the user.
### But... Why?
I needed a quick app that updates my about locally running server. I have multiple scripts running which, being the great coder that I am, might break due to any number of reasons. I needed a simple way to update me whenever something broke and this seemed like the most user friendly.
### Future plans
- Adding support for custom messages, log, warning, info, error among other things.
- Adding support for multiple users.
### Error & Bugs
- If you issue a PR fixing any vulnerability or bug, I will definitely approve it.
- If you report a bug, I will get to it when I get to it.