ticker

The API for the Systemli Ticker Project — a service to distribute short messages in support of events, demonstrations, or other time-sensitive events.

This repository contains the backend. A complete installation also needs ticker-admin (admin interface) and ticker-frontend (public page).

Documentation

https://systemli.github.io/ticker/

The documentation covers the whole stack, for all three repositories:

• Installation — Docker Compose and Traefik
• Configuration
• Integrations — Telegram, Mastodon, Bluesky, Signal
• Operations — upgrades, backups, users
• Troubleshooting
• Development

The sources live in docs/.

Quick start

git clone https://github.com/systemli/ticker.git
cd ticker
cp .env.example .env # set the hostnames and TICKER_SECRET
docker compose up -d
docker compose run --rm ticker user create --email admin@example.org --super-admin

See the installation guide for DNS requirements and the remaining setup — in particular registering your frontend's address on the ticker, which is what makes the public page work.

Contributing

Contributions are welcome. Fork the repository, commit your changes, and open a pull request.

AGENTS.md documents the project layout, code style, testing conventions and commit format. For a local environment, see the development guide:

docker compose -f compose.dev.yaml up -d --build # the whole stack
go test ./...

Licence

GPL-3.0. See LICENSE.