Skip to content

Makefile Reference

All commands run from the Quickstart/ directory.


Required Repositories per Target

Clone all repos into the same root folder before running any make command.

Target Command Repos Required
noauths make noauths Quickstart, CoreAPI, PlayoutAdmin, documentation
media make media Quickstart, CoreAPI, PlayoutAdmin, documentation
demo make demo Quickstart, CoreAPI, PlayoutAdmin
demo2 make demo2 Quickstart, CoreAPI, PlayoutAdmin
up-infra make up-infra Quickstart only
apidocs make apidocs Quickstart, documentation
hamilton make hamilton Quickstart, CoreAPI
dev make dev Quickstart, CoreAPI, PlayoutAdmin, OrgConsole, PlatformConsole, SpatioAdmin, TellyboardAdmin
tkt make tkt Quickstart, TicketAPI, TicketCMS, TicketAdmin

Missing repo = build failure

Docker Compose resolves build contexts relative to the Quickstart folder. If a referenced repo is missing, the entire make command fails — even services that don't depend on it may not start.

Your root folder should look like this for make noauths: Roots/ ├── Quickstart/ ├── CoreAPI/ ├── PlayoutAdmin/ └── documentation/


Infrastructure Profiles

Variable Contents
INFRA Postgres, Redis, VerneMQ, Zitadel
LITE Postgres, SeaweedFS, tusd, CDN (streamer nodes)
SERVICES CoreAPI, OrgConsole, PlatformConsole, PlayoutAdmin, SpatioAdmin, TellyboardAdmin
ACCESS TellyID
HAMILTON AuthAPI

Common Commands

# Start noauths stack (recommended for CoreAPI development)
make noauths

# Start in detached mode
make noauths-d

# Tear down
make noauths-down

# Tear down and wipe volumes
make noauths-down-v

# Documentation site only
make apidocs

# Rebuild without cache
make rebuild

# Follow logs
make logs

# Reset infrastructure volumes and restart
make reset-infra

Environment Files

# Default
make noauths                        # uses .env

# Staging
make staging                        # uses .env.staging

# Production
make prod-deploy                    # uses .env.prod