Skip to content
Roster Roster Roster Docs

Getting Started

Roster ships as a single deployable platform image and exposes four integration surfaces from the same runtime:

  • web platform
  • REST API
  • CLI access through MCP
  • MCP server for agent runtimes

Prerequisites

Section titled “Prerequisites”
  • Docker or a container platform that can run the advantys/roster image
  • a persistent /data volume
  • a generated ROSTER_AUTH_SECRET
  • an explicit MCP auth mode for production
  • provider-secret encryption keys when using directory connectors

Production Defaults

Section titled “Production Defaults”

Use a persistent data directory for SQLite, worker journals, connector files, and runtime state:

ROSTER_DATA_DIR=/data
NODE_ENV=production

With ROSTER_DATA_DIR=/data and no ROSTER_DATABASE_URL, SQLite defaults to /data/roster.db.

Configure MCP authentication before exposing the server:

ROSTER_MCP_AUTH_MODE=oauth

Use api_key,oauth only when production automation also needs API-key MCP access alongside OAuth-based end-user MCP clients.

First Production Checklist

Section titled “First Production Checklist”
  • Mount /data on durable storage.
  • Set ROSTER_AUTH_SECRET to a high-entropy secret.
  • Set ROSTER_MCP_AUTH_MODE to oauth for end-user MCP clients, or api_key,oauth when automation also needs API-key access.
  • Set ROSTER_MCP_RESOURCE_URI when using OAuth.
  • Set ROSTER_PROVIDER_SECRET_ENCRYPTION_KEY before storing connector secrets.
  • Configure identity providers for human login.
  • Create API keys with only the scopes each integration needs.

Next Steps

Section titled “Next Steps”