Heartlock

Getting Started

  • Quickstart
    • Prerequisites
    • Local development
    • Docker Compose (production)
    • First-run onboarding
      • Opting out of onboarding
    • Building the CLI

Configuration

  • Server Configuration
    • Core settings
    • Encryption at rest
    • Database
      • SQLite (default)
      • PostgreSQL
    • CORS and CSRF
    • OIDC single sign-on
      • OIDC admin API
      • Config-file precedence
    • Email / SMTP
    • Production hardening
    • Docker image details
    • Security notes
  • CLI Configuration
    • Installing
    • Building from source
    • Commands
      • heartlock login [--server URL] [--force|-f]
      • heartlock whoami
      • heartlock projects
      • heartlock environments --project <slug|id>
      • heartlock secrets --project <slug|id> --env <slug|id>
      • heartlock run --project <slug|id> --env <slug|id> [-- command args...]
      • heartlock import-env [--project <slug|id>] [--env <slug|id>] [file]
      • heartlock logout
      • heartlock config [--server URL]
    • Configuration file
    • Configuration precedence
    • API endpoints used by the CLI

Reference

  • API Reference
    • Authentication
      • Session authentication
      • Service token authentication
    • Roles and permissions
    • Health
    • Authentication endpoints
    • Service tokens
    • Projects
    • Project members
    • Project invitations
    • Environments
    • Secrets
    • Onboarding / setup
    • Superuser administration
      • Overview
      • Users
      • Projects
      • Members
      • Invitations
      • OIDC configuration
    • OIDC SSO flow
Heartlock
  • Search

© Copyright 2026, Jouleworks.

Built with Sphinx using a theme provided by Read the Docs.