startung/signaalbot

By startung

Updated 5 months ago

A Signal bot, that routes /command-style messages to pluggable command apps.

Image
Message queues
0

431

startung/signaalbot repository overview

Signaalbot

Signaal is the Dutch word for signal.

A lightweight, extensible Signal bot built in Python. It polls for incoming messages via signal-cli, routes /command-style messages to pluggable command apps, and logs all traffic to daily text files.

Quick start

You only need Docker and a phone number registered with Signal.

curl -O https://raw.githubusercontent.com/startung/signaalbot/main/docker-compose.yml

Create a .env file:

SIGNAL_PHONE_NUMBER=+YOUR_PHONE_NUMBER
ALLOWED_SENDERS=+YOUR_NUMBER

Register with Signal (one-time):

docker compose run --rm signal-cli -a +YOUR_PHONE_NUMBER register
docker compose run --rm signal-cli -a +YOUR_PHONE_NUMBER verify 123-456

Start the bot:

docker compose up -d

Built-in commands

CommandDescription
/test <text>Reverses the text you send
/date [city]Shows current date/time, optionally for a city
/date set City, CountrySaves a default city for /date
/helpLists all registered commands

Configuration

Key environment variables:

VariableDefaultDescription
SIGNAL_PHONE_NUMBER-Phone number registered with Signal (required)
ALLOWED_SENDERS-Comma-separated list of phone numbers allowed to send commands (required)
LOG_DIRlogsDirectory for message logs
DATA_DIRdataDirectory for persistent app data

See the Configuration Reference for the full list of options.

Tag summary

Content type

Image

Digest

sha256:2f1a30d4b

Size

132.5 MB

Last updated

5 months ago

docker pull startung/signaalbot:2.1.0