Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1 KB

deployment.md

File metadata and controls

39 lines (27 loc) · 1 KB

FastAPI Project - Deployment

Preparation

  1. Create production env values from .env.example.
  2. Set ENVIRONMENT=production.
  3. Set POSTGRES_* for your production database.
  4. Set AUTH_TOKEN as a SHA-256 hex digest (64 lowercase chars) of your bearer token.
  5. Optionally set GUARDRAILS_HUB_API_KEY and SENTRY_DSN.

Generate AUTH token hash:

echo -n "your-plain-text-token" | shasum -a 256

Deploy the FastAPI Project

Build and start backend:

docker compose build backend
docker compose up -d backend

Run migrations and initial setup (recommended before or during first rollout):

docker compose --profile prestart up prestart

Default host endpoint:

  • API/Docs host: http://<host>:8001
  • Health check: http://<host>:8001/api/v1/utils/health-check/

Continuous Deployment (CD)

CI workflow is defined in .github/workflows/continuous_integration.yml. It runs dependency install, Guardrails validator installation, migrations, pre-commit checks, and tests.