-
Notifications
You must be signed in to change notification settings - Fork 11
feat: add docker compose setup #221
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+79
−6
Merged
Changes from 10 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
1beb54a
feat: add docker compose setup
sriramveeraghanta f15f7f5
fix: formatting
sriramveeraghanta f1810ef
fix: sidebar item change
sriramveeraghanta 134399b
fix: layout change
sriramveeraghanta 5307e99
fix: version update
sriramveeraghanta 8926b7d
fix: minor fixes
sriramveeraghanta aab10af
fix: formatting
sriramveeraghanta b06b2f3
fix: formatting
sriramveeraghanta b37fc23
review fixes
danciaclara 66c6628
title changes
danciaclara c873140
minor fix
danciaclara 946ce26
minor fix
danciaclara 898f992
removed javascript and python templats
danciaclara 8619a8c
modified api reference style
danciaclara 8a8a8e1
fix: content ordering
sriramveeraghanta b899493
fix: formatting
sriramveeraghanta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| ## 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-hosteds) 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 | ||
|
|
||
| <div class="api-endpoint-badge"> | ||
| <span class="method get">GET</span> | ||
| <span class="path">/api/v2/setup/</span> | ||
| </div> | ||
|
|
||
| <div class="api-two-column"> | ||
| <div class="api-left"> | ||
|
|
||
| **Base URL:** `https://prime.plane.so` | ||
|
|
||
| **Authentication:** Not required (public endpoint) | ||
|
|
||
| <div class="params-section"> | ||
|
|
||
| ### Query parameters | ||
|
|
||
| <div class="params-list"> | ||
|
|
||
| <ApiParam name="version" type="string" :required="true"> | ||
|
|
||
| Release tag (e.g., `v2.3.4`). | ||
|
|
||
| </ApiParam> | ||
|
|
||
| <ApiParam name="airgapped" type="boolean"> | ||
|
|
||
| Set to `true` for airgapped compose files. Defaults to `false`. | ||
|
|
||
| </ApiParam> | ||
|
|
||
| <ApiParam name="platform" type="string"> | ||
|
|
||
| Target architecture: `amd64` or `arm64`. Defaults to `amd64`. Only applies when `airgapped=true`. | ||
|
|
||
| </ApiParam> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| <div class="params-section"> | ||
|
|
||
| ### 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"}` | | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| <div class="api-right"> | ||
|
|
||
| <CodePanel :languages="['cURL', 'Python', 'JavaScript']"> | ||
| <template #curl> | ||
|
|
||
| ```bash | ||
| # 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 | ||
| ``` | ||
|
|
||
| </template> | ||
| <template #python> | ||
|
|
||
| ```python | ||
| 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) | ||
| ``` | ||
|
|
||
| </template> | ||
| <template #javascript> | ||
|
|
||
| ```javascript | ||
| // 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(); | ||
| ``` | ||
|
|
||
| </template> | ||
| </CodePanel> | ||
|
|
||
| </div> | ||
| </div> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.