Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gregyjames/telegram-notifier

A simple, lightweight, self-hosted REST server for Raspberry Pi that sends Telegram notifications.
https://github.com/gregyjames/telegram-notifier

docker docker-compose docker-image notification notifications notify raspberry-pi raspberrypi rest-api restapi self-hosted selfhosted telegram

Last synced: 1 day ago
JSON representation

A simple, lightweight, self-hosted REST server for Raspberry Pi that sends Telegram notifications.

Host: GitHub
URL: https://github.com/gregyjames/telegram-notifier
Owner: gregyjames
License: mit
Created: 2024-11-18T05:37:07.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-12-28T06:52:50.000Z (29 days ago)
Last Synced: 2025-01-17T18:59:30.807Z (9 days ago)
Topics: docker, docker-compose, docker-image, notification, notifications, notify, raspberry-pi, raspberrypi, rest-api, restapi, self-hosted, selfhosted, telegram
Language: Go
Homepage: https://hub.docker.com/repository/docker/gjames8/telegram-notifier/
Size: 45.9 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![Docker Image CI](https://github.com/gregyjames/telegram-notifier/actions/workflows/docker-image.yml/badge.svg)](https://github.com/gregyjames/telegram-notifier/actions/workflows/docker-image.yml)
![GitHub repo size](https://img.shields.io/github/repo-size/gregyjames/telegram-notifier)
![Docker Image Size (tag)](https://img.shields.io/docker/image-size/gjames8/telegram-notifier/latest)
![Docker Pulls](https://img.shields.io/docker/pulls/gjames8/telegram-notifier)

# telegram-notifier
A simple, self-hosted REST server for Raspberry Pi that sends Telegram notifications.

## How to use
### Docker compose

```yaml
services:
telegram:
container_name: telegram_notifier
image: gjames8/telegram-notifier:latest
restart: unless-stopped
ports:
- "8080:8080"
volumes:
- ./telegram:/usr/src/app/data
```
### Create config
In the same directory as your Compose file, create a new folder named `telegram` and create a `config.json` file with the following contents:
```json
{
"key": "Telegram API KEY from BotFather",
"chatid": "Telegram ChatID"
}
```
### Run
`docker compose up -d`

### Send message
`curl "http://SERVERIP:8080/get?message=hello"`

## Features
- Fast
- Extreamly Lightweight (1.76MB!)
- Quick Setup

## License
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.