diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 297f9ba..90a6026 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -215,6 +215,7 @@ export default withMermaid( { text: "Docker Compose", link: "/self-hosting/methods/docker-compose" }, { text: "Docker AIO", link: "/self-hosting/methods/docker-aio" }, { text: "Docker Swarm", link: "/self-hosting/methods/docker-swarm" }, + { text: "Download config files", link: "/self-hosting/methods/download-config" }, ], }, { text: "Kubernetes", link: "/self-hosting/methods/kubernetes" }, diff --git a/docs/self-hosting/manage/backup-restore.md b/docs/self-hosting/manage/backup-restore.md index f17700a..c0d1e3b 100644 --- a/docs/self-hosting/manage/backup-restore.md +++ b/docs/self-hosting/manage/backup-restore.md @@ -9,6 +9,7 @@ keywords: plane backup, plane restore, database backup, postgresql backup, data Backing up your data regularly helps prevent data loss and allows you to restore your system quickly if necessary. Follow these instructions to back up and restore your data using Plane’s command-line interface. ## For Docker Compose + ### Backup data ::: warning @@ -152,15 +153,14 @@ That’s it! You’re back up and running with your restored data. ::: - ## Other deployment methods For Kubernetes, or other deployment methods, use your platform's native backup tools. Plane stores data in two places that need to be backed up: -| Component | What it contains | -|-----------|------------------| +| Component | What it contains | +| ----------------------- | ---------------------------------------------------------------------------- | | **PostgreSQL database** | All Plane data — workspaces, projects, work items, users, comments, settings | -| **Object storage** | Attachments, uploaded images, files (MinIO, S3, or S3-compatible storage) | +| **Object storage** | Attachments, uploaded images, files (MinIO, S3, or S3-compatible storage) | ### Configuration files @@ -171,4 +171,4 @@ Also back up your environment configuration — this includes database connectio :::tip Store backups in a separate location from your Plane installation — ideally offsite or in a different cloud region. -::: \ No newline at end of file +::: diff --git a/docs/self-hosting/methods/download-config.md b/docs/self-hosting/methods/download-config.md new file mode 100644 index 0000000..61af22f --- /dev/null +++ b/docs/self-hosting/methods/download-config.md @@ -0,0 +1,73 @@ +--- +title: Download Docker config files +description: Download docker-compose.yml and variables.env files for a specific Plane release as a zip archive. +keywords: plane, self-hosting, setup, docker compose, config download, version config, airgapped, variables.env +--- + +# 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=&airgapped=&platform=" -o plane.zip +``` + +**Authentication:** None required (public endpoint) + +## Parameters + +| Parameter | Required | Default | Description | +| ----------- | -------- | ------- | ---------------------------------------------------------------------------- | +| `version` | Yes | — | Release tag (e.g., `v2.3.4`) | +| `airgapped` | No | `false` | Set to `true` for airgapped compose files | +| `platform` | No | `amd64` | Target 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](https://plane.so/changelog?category=self-hosted) for available versions. + +### Error responses + +| 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: "}` | +| 500 | GitHub API failure | `{"error": "Failed to fetch release information"}` | diff --git a/docs/self-hosting/upgrade-from-community.md b/docs/self-hosting/upgrade-from-community.md index 3fb40cb..e96e47c 100644 --- a/docs/self-hosting/upgrade-from-community.md +++ b/docs/self-hosting/upgrade-from-community.md @@ -231,7 +231,6 @@ prime-cli restart ::: - ## What's next - [Activate a paid plan license](/self-hosting/manage/manage-licenses/activate-pro-and-business).