Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hlf20010508/omni-notify
A notification server written in rust.
https://github.com/hlf20010508/omni-notify
notification rust
Last synced: about 5 hours ago
JSON representation
A notification server written in rust.
- Host: GitHub
- URL: https://github.com/hlf20010508/omni-notify
- Owner: hlf20010508
- License: mit
- Created: 2024-01-19T01:31:11.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-06-18T03:23:48.000Z (5 months ago)
- Last Synced: 2024-06-18T04:39:50.824Z (5 months ago)
- Topics: notification, rust
- Language: Rust
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# omni-notify
A notification server written in rust.
## Introduction
Send notification through
- Email
- [PushDeer](https://github.com/easychen/pushdeer)
- Telegram
## API
All APIs support `GET`, `POST-FORM`, `POST-JSON`.
- Email
- Path: `/email`
- Parameters:
- `title`
- `body`
- Pushdeer
- Path: `/pushdeer`
- Parameters:
- `title`
- `body` (optional)
- Telegram
- Path: `/telegram`
- Parameter: `text`
## Deploy
To get your Telegram Chat ID, you need to send a message to your bot and visit `https://api.telegram.org/bot/getUpdates` to check `result[0].message.chat.id`. Replace `` with your bot token.
**You don't need to set the parameters if you don't need the feature.**
```yml
version: '3.8'
services:
omni-notify:
container_name: omni-notify
image: hlf01/omni-notify
restart: always
ports:
- xxxx:8080
command: >
--email-address [email protected]
--email-smtp-server smtp.xxxx.com
--email-smtp-username xxxxxx
--email-smtp-password xxxxxx
--pushdeer-key xxxxxx
--tg-bot-token xxxxxx
--tg-chat-id xxxxxx
```
## Docker Build
```sh
docker build --tag omni-notify --no-cache .
```