ShortMesh Builds

Docker Compose orchestration for ShortMesh services.

Prerequisites

• Docker (v20.10+)
• Docker Compose (v2.0+)

Installation guides:

• Docker Installation
• Docker Compose v2 is included with Docker Desktop

Quick Start

make setup    # Configure all services
make up       # Start services
make logs     # View logs

Services

Service	Port	Description
rabbitmq	(internal)	Message broker
matrix-client	(internal)	Matrix client with bridges
interface-api	127.0.0.1:8082	Core API
authy-api	127.0.0.1:8083	Authentication API

Configuration

See CONFIGURATION.md for detailed configuration guide.

Commands

Run make help for all available commands.

Setup

make setup               # Full setup (all services)
make setup-env           # Environment variables
make setup-client        # Matrix client
make setup-interface     # Interface API
make setup-authy         # Authy API
make fetch-defaults      # Fetch fresh defaults from upstream

Control

make up                  # Start all services
make down                # Stop all services
make restart             # Restart all services
make restart-shortmesh   # Restart ShortMesh services only

Logs

make logs                # All services
make logs-shortmesh      # ShortMesh services
make logs-client         # Matrix client
make logs-interface      # Interface API
make logs-authy          # Authy API
make logs-rabbitmq       # RabbitMQ

Database

make migrate-interface   # Run Interface migrations
make migrate-authy       # Run Authy migrations

Build

make build               # Build all images
make rebuild             # Rebuild and restart
make rebuild-shortmesh   # Rebuild ShortMesh only

Debug

make shell-client        # Shell access to client
make shell-interface     # Shell access to Interface API
make shell-authy         # Shell access to Authy API

Maintenance

make health              # Check service health
make stats               # View resource usage
make backup              # Backup configurations
make clean               # Remove stopped containers
make clean-config        # Remove all generated configs
make pull                # Pull latest images

Configuration

Service configs are in config/<service>/. See individual config/<service>/README.md for details.

URLs

• Interface API Admin: http://localhost:8082/admin
• Interface API Docs: http://localhost:8082/docs/index.html
• Authy API Docs: http://localhost:8083/docs/index.html

Troubleshooting

Check status:

make health              # Quick health check
docker compose ps        # Container status
docker compose logs <service>  # View logs

Reset everything:

make down
make clean-config
make setup