tellme/README.md

TellMe

A server and client notifications system written in Python that alerts you of events via SimpleX chat.

Overview

TellMe monitors for events (completed processes, server uptime, etc.) and sends notifications through a built-in server to SimpleX chat over websockets. Starting from version 2.2, TellMe supports GoAlert messages natively.

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:

{
  "url": "http://your-server:8000",
  "webhook": "your-webhook-name"
}

2. Run the SimpleX CLI chat as a daemon.

3. Configure /etc/tellme/hooks.yml to map webhooks to SimpleX chatrooms.

4. Run the server and use the client CLI to send notifications.

Ansible

An example Ansible role is included in Ansible/tellme_notification for integrating TellMe notifications into Ansible playbooks.

Created by Taurix IT (https://www.taurix.net) | Licensed under AGPLv3+