Documentation

Getting Started

Deploy your first SOMA service in under ten minutes.

Prerequisites

  • Docker 24+ or a Linux host with systemd
  • Postgres 15+
  • 256 MB RAM (soma-control), 128 MB RAM (each additional service)

Quick start with Docker

docker pull ghcr.io/soma-platform/soma-control:latest

docker run -d \
  --name soma-control \
  -e DATABASE_URL=postgres://user:pass@host/db \
  -e SOMA_SECRET_KEY=$(openssl rand -hex 32) \
  -p 4000:4000 \
  ghcr.io/soma-platform/soma-control:latest

The service starts in under a second and exposes:

Path Description
GET /health Liveness probe
GET /.well-known/openid-configuration OIDC discovery
POST /auth/token Token endpoint

Running migrations

soma-control uses soma-schema for migrations. On first start, pass --migrate to apply pending migrations automatically, or run the CLI separately:

soma-schema migrate --database-url $DATABASE_URL --schema soma_control

Next steps

More docs are on the way — see the roadmap for what is planned next.