Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 5.72 KB

README.md

File metadata and controls

75 lines (48 loc) · 5.72 KB

@powersync/cli-plugin-docker

Bundled plugin: This plugin is automatically included in the powersync package. You do not need to install it separately — all powersync docker commands are available out of the box when you install powersync.

PowerSync CLI plugin that adds a docker topic for self-hosted instances: configure, reset, start, and stop using Docker Compose.

Commands

All commands live under powersync docker:

  • powersync docker configure – Create powersync/docker/ with database and storage modules (see Templates below). Requires --database and --storage. Creates docker-compose.yaml, .env (with defaults), and merges service snippets into service.yaml (preserving !env so the container resolves vars from .env). Writes cli.yaml with plugins.docker.project_name for reset/start/stop.
  • powersync docker start – Start the stack (docker compose up -d --wait). Use this after configure to bring up the stack.
  • powersync docker reset – Start from a clean state: stop and remove containers (docker compose down), then start (docker compose up -d --wait). Use only when you need a clean state (e.g. after config changes).
  • powersync docker stop – Stop the stack (docker compose stop by default; use --remove for down, --remove-volumes for down -v).

Run powersync docker with no subcommand to see help.

All commands use the same project and directory resolution as the main CLI (e.g. --directory powersync). They require a self-hosted PowerSync project (service.yaml with _type: self-hosted). Linking (cli.yaml / API_URL / PS_ADMIN_TOKEN) is optional.

Templates (composable modules)

Templates are organized by category and implementation:

  • templates/source-database/ – Replication source (e.g. postgres). Used by --database.
  • templates/bucket-storage/ – PowerSync bucket metadata (e.g. postgres). Used by --storage.
  • templates/backend/ – (Reserved for future use.)

Each implementation provides:

  • A compose partial <impl>.<category>.compose.yaml (e.g. postgres.database.compose.yaml, postgres.storage.compose.yaml). Storage modules define their own service(s) (e.g. pg-storage).
  • A service snippet <impl>.<category>.service.yaml – YAML merged into the project service.yaml (replication and storage sections). Snippets use the !env custom tag (e.g. uri: !env PS_DATA_SOURCE_URI) so the PowerSync container resolves values from docker/.env at runtime.
  • template.env – Env vars for that module. Init merges these into powersync/docker/.env.

powersync docker configure copies the selected modules into powersync/docker/modules/, generates docker-compose.yaml (include of both partials + PowerSync service with env_file: .env), writes .env (merged from template.env snippets + PowerSync vars), and merges the service snippets into service.yaml (preserving !env tags).

Example

powersync docker configure --database postgres --storage postgres

Creates powersync/docker/ with:

  • modules/database-postgres/ – postgres.database.compose.yaml (pg-db), postgres.database.service.yaml snippet, template.env.
  • modules/storage-postgres/ – postgres.storage.compose.yaml (pg-storage), postgres.storage.service.yaml snippet, template.env.
  • docker-compose.yaml – include: of both partials + PowerSync service (depends on pg-db and pg-storage; uses env_file: .env).
  • .env – Merged from template.env snippets and PowerSync vars (defaults; no manual setup required for basic use).

Also merges the database and storage snippets into powersync/service.yaml (replication and storage with !env preserved) and creates/updates cli.yaml with plugins.docker.project_name (derived from the config directory name). When running docker stop, use --project-name to target a specific project or run from another directory.

Usage

  1. From the repo root, run powersync docker configure --database postgres --storage postgres to create powersync/docker/.
  2. Run powersync docker start to bring up the stack. Use powersync docker reset only when you need to start from a clean state (stop and remove, then start). Use powersync docker stop to stop.

No need to edit .env for default setups; the PowerSync service reads docker/.env via env_file and resolves !env in service.yaml at runtime.

Flags

  • --directory – Config directory (default: powersync).
  • --database – Database module for docker configure (e.g. postgres). Required for configure.
  • --storage – Storage module for docker configure (e.g. postgres). Required for configure.
  • --project-name – For stop only: Docker Compose project name (e.g. powersync_myapp). Default: plugins.docker.project_name from cli.yaml when run from the project directory. Use to stop from any directory or target a specific project.
  • --api-url – PowerSync API URL (optional; for consistency with other self-hosted commands).

Building blocks

This plugin uses @powersync/cli-core, which provides:

  • SelfHostedInstanceCommand – Base class with loadProject() and parseConfig() for project dir, link config, and service.yaml.
  • Types: SelfHostedProject, SelfHostedInstanceCommandFlags, EnsureConfigOptions.
  • HelpGroup, InstanceCommand, PowerSyncCommand.
  • YAML helpers: parseYamlFile, parseYamlDocumentPreserveTags, stringifyYaml (for !env-aware parsing).

Import from @powersync/cli-core when authoring your own self-hosted plugins.