Skip to content

Download Docker config files

If you're running a custom Docker setup and don't use prime-cli, you can download the docker-compose.yml and variables.env files for any Plane release directly.

Endpoint

bash
curl "https://prime.plane.so/api/v2/setup/?version=<version>&airgapped=<true|false>&platform=<amd64|arm64>" -o plane.zip

Authentication: None required (public endpoint)

Parameters

ParameterRequiredDefaultDescription
versionYesRelease tag (e.g., v2.3.4)
airgappedNofalseSet to true for airgapped compose files
platformNoamd64Target architecture: amd64 or arm64. Only applies when airgapped=true.

What's in the zip

Standard download

  • docker-compose.yml
  • variables.env

Airgapped download

  • airgapped-docker-compose-{platform}.yml
  • variables.env

Quick download

Standard setup

bash
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4" -o plane.zip
unzip plane.zip

Airgapped setup (AMD64)

bash
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true" -o plane.zip
unzip plane.zip

Airgapped setup (ARM64)

bash
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true&platform=arm64" -o plane.zip
unzip plane.zip

Replace v2.3.4 with the version you need. See the releases page for available versions.

Error responses

StatusCauseResponse
400Missing version parameter{"error": "version query parameter is required"}
400Invalid platform value{"error": "platform must be amd64 or arm64"}
400Server missing GitHub configuration{"error": "missing required settings"}
404Release tag not found{"error": "release not found"}
404Config files missing from release{"error": "assets not found in release: <filenames>"}
500GitHub API failure{"error": "Failed to fetch release information"}