Infobús

A real-time public transportation information system, developed. Infobús processes GTFS Schedule and Realtime feeds and delivers live transit information through digital displays at bus stops, a web frontend, REST APIs, and WebSocket streams — all orchestrated through Docker Compose.

Architecture

See ARCHITECTURE.md for detailed service mandates and design principles.

Django apps (backend/)

• website — Main site pages, user management, public interfaces
• alerts — Screen management, real-time data display via WebSockets
• gtfs — GTFS Schedule and Realtime data (Git submodule)
• engine — Information service providers and WebSocket consumers
• api — RESTful API endpoints with DRF integration

Data flow

1. Celery tasks periodically fetch GTFS Realtime feeds from transit agencies
2. Data is validated, processed, and classified by relevance to specific screens/stops
3. Django Channels WebSockets push live updates to connected display screens
4. Raspberry Pi devices in kiosk mode render the passenger information

Getting Started

Prerequisites

• Docker Engine 24+ and Docker Compose v2
• Git

Setup

git clone https://github.com/simovilab/infobus.git
cd infobus
cp .env.example .env   # edit with your values
./scripts/dev.sh

The startup script pulls images, builds containers, runs migrations, and waits for all services to become healthy. On first run this takes 1–2 minutes.

Development URLs

Common commands

# Logs
docker compose -f compose.dev.yml logs -f              # all services
docker compose -f compose.dev.yml logs -f orchestrator  # single service

# Django management
docker compose -f compose.dev.yml exec orchestrator uv run python manage.py migrate
docker compose -f compose.dev.yml exec orchestrator uv run python manage.py createsuperuser
docker compose -f compose.dev.yml exec orchestrator uv run python manage.py shell

# Stop
docker compose -f compose.dev.yml down

Code quality

# From backend/
ruff check .
ruff format .
mypy .
pytest

Production Deployment

Production runs on Docker Compose behind a Traefik reverse proxy that handles TLS termination via Let's Encrypt. All traffic goes through port 443. No services expose ports directly to the host.

Quick start

cp .env.example .env   # add production domains and credentials (see below)
./scripts/prod.sh

Required environment variables

# Domain routing (Traefik)
ORCHESTRATOR_DOMAIN=api.example.com
UI_DOMAIN=app.example.com
KNOWLEDGE_DOMAIN=knowledge.example.com
CONTEXT_DOMAIN=context.example.com
BROKER_DOMAIN=broker.example.com
DOCS_DOMAIN=docs.example.com
CERT_RESOLVER=letsencrypt

# Credentials
SECRET_KEY=<generate-a-strong-key>
DB_PASSWORD=<strong-password>
REDIS_PASSWORD=<strong-password>
RABBITMQ_USER=infobus
RABBITMQ_PASS=<strong-password>

Production services

Internal-only (not exposed): database, memory, engine, scheduler.

Common operations

# Rebuild and restart after code changes
docker compose -f compose.prod.yml build orchestrator user-interface
docker compose -f compose.prod.yml up -d orchestrator user-interface

# Django management
docker compose -f compose.prod.yml exec orchestrator uv run python manage.py migrate
docker compose -f compose.prod.yml exec orchestrator uv run python manage.py createsuperuser

# Stop
docker compose -f compose.prod.yml down

API

REST endpoints

WebSocket endpoints

Documentation

• ARCHITECTURE.md — Service mandates and design principles
• docs/ — Full documentation site (run locally or deployed at DOCS_DOMAIN)

Contributing

See the guidelines.

Contact

• Email: [email protected]
• Website: simovi.org

License

Apache 2.0