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.

Quick download

Standard setup

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

Airgapped setup (AMD64)

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

Airgapped setup (ARM64)

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.

What's in the zip

Standard download

• docker-compose.yml
• variables.env

Airgapped download

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

---

API reference

GET/api/v2/setup/

Base URL: https://prime.plane.so

Authentication: Not required (public endpoint)

Query parameters

version:requiredstring

Release tag (e.g., v2.3.4).

airgapped:optionalboolean

Set to true for airgapped compose files. Defaults to false.

platform:optionalstring

Target architecture: amd64 or arm64. Defaults to amd64. Only applies when airgapped=true.

Response

Success (200): Returns a zip archive containing the config files.

• Content-Type: application/zip
• Content-Disposition: attachment; filename="plane-{version}.zip"

Zip contents by mode

Standard (airgapped=false or omitted):

• docker-compose.yml
• variables.env

Airgapped (airgapped=true):

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

Examples

Download standard config files

Errors

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

# Download standard config files
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4" \
  -o plane.zip

# Download airgapped config (AMD64)
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true" \
  -o plane.zip

# Download airgapped config (ARM64)
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true&platform=arm64" \
  -o plane.zip

# Verify zip contents without extracting
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4" \
  -o plane.zip && unzip -l plane.zip

import requests

# Download standard config files
response = requests.get(
    "https://prime.plane.so/api/v2/setup/",
    params={"version": "v2.3.4"},
)

with open("plane.zip", "wb") as f:
    f.write(response.content)

# Download airgapped config (ARM64)
response = requests.get(
    "https://prime.plane.so/api/v2/setup/",
    params={
        "version": "v2.3.4",
        "airgapped": "true",
        "platform": "arm64",
    },
)

with open("plane.zip", "wb") as f:
    f.write(response.content)

// Download standard config files
const response = await fetch("https://prime.plane.so/api/v2/setup/?version=v2.3.4");
const blob = await response.blob();

// Download airgapped config (ARM64)
const airgappedResponse = await fetch(
  "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true&platform=arm64"
);
const airgappedBlob = await airgappedResponse.blob();