Update README with setup instructions and features
This commit is contained in:
36
README.md
36
README.md
@@ -1,6 +1,36 @@
|
|||||||
# TellMe
|
# TellMe
|
||||||
|
|
||||||
TellMe is a server and client application written in Python that will notify you of an event.
|
A server and client notifications system written in Python that alerts you of events via SimpleX chat.
|
||||||
TellMe 2.0 has been rewritten with a built-in server (over OpsDroid or Home Assistant) that talks to SimpleX chat over websockets.
|
|
||||||
|
|
||||||
It is created by Taurix IT (https://www.taurix.net) and licensed under the AGPLv3 or later.
|
## Overview
|
||||||
|
|
||||||
|
TellMe monitors for events (completed processes, server uptime, etc.) and sends notifications through a built-in server to SimpleX chat over websockets.
|
||||||
|
|
||||||
|
## Client Features
|
||||||
|
|
||||||
|
- **Send messages**: `-m "Your message"` - Send custom notifications
|
||||||
|
- **Monitor processes**: `-p <pid>` - Wait for a process to exit, then notify
|
||||||
|
- **Watch commands**: `-w "command"` - Run a command periodically and notify on output
|
||||||
|
- **Ping hosts**: `-P <host>` - Monitor host availability until it's reachable
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
1. Configure the client in `~/.config/tellme/config.json`:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"url": "http://your-server:8000",
|
||||||
|
"webhook": "your-webhook-name"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Run the SimpleX CLI chat as a daemon.
|
||||||
|
|
||||||
|
3. Configure `hooks.yml` to map webhooks to SimpleX chatrooms.
|
||||||
|
|
||||||
|
4. Run the server and use the client CLI to send notifications.
|
||||||
|
|
||||||
|
**Note**: Starting from version 2.2, TellMe supports GoAlert messages natively.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Created by Taurix IT (https://www.taurix.net) | Licensed under AGPLv3+
|
||||||
Reference in New Issue
Block a user