Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation updates across three self-hosting guides: typo corrections ("depoyment" → "deployment") in Coolify and Portainer guides, and restructuring of the Docker Swarm guide with reformatted steps, explicit code blocks, and numbered step sequencing for improved clarity. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
pushya22
approved these changes
Feb 5, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/self-hosting/methods/docker-swarm.md`:
- Around line 27-58: The doc downloads the env file as plane.env but later
references variables.env (e.g., the sed command and the load step using source
<path-to variables.env>), causing a filename mismatch; make the filenames
consistent by either changing the download command to save as variables.env or
updating all subsequent references (the sed line updating MACHINE_SIGNATURE and
the load step using set -o allexport; source ...) to use plane.env so every
mention (variables.env / plane.env) matches across the document.
Comment on lines
+27
to
+58
| - `variables.env` – Stores environment variables for your deployment. | ||
|
|
||
| - `DOMAIN_NAME` – (required) Your application's domain name. | ||
| - `SITE_ADDRESS` – (required) The full domain name (FQDN) of your instance. | ||
| - `MACHINE_SIGNATURE` – (required) A unique identifier for your machine. You can generate this by running below code in terminal: | ||
| ```sh | ||
| sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env | ||
| ``` | ||
| - `CERT_EMAIL` – (optional) Email address for SSL certificate generation (only needed if you're setting up HTTPS). | ||
| ```bash | ||
| curl -fsSL https://prime.plane.so/releases/<plane-version>/variables.env -o plane.env | ||
| ``` | ||
|
|
||
| ::: warning | ||
| The `<plane-version>` value should be v1.8.3 or higher. | ||
| ::: | ||
|
|
||
| 2. **Configure environment variables** | ||
| Before deploying, edit the `variables.env` file in your preferred text editor and update the following values: | ||
| - `DOMAIN_NAME` – (required) Your application's domain name. | ||
| - `SITE_ADDRESS` – (required) The full domain name (FQDN) of your instance. | ||
| - `MACHINE_SIGNATURE` – (required) A unique identifier for your machine. You can generate this by running below code in terminal: | ||
| ```sh | ||
| sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env | ||
| ``` | ||
| - `CERT_EMAIL` – (optional) Email address for SSL certificate generation (only needed if you're setting up HTTPS). | ||
|
|
||
| 3. **Configure external DB, Redis, and RabbitMQ** | ||
| ::: warning | ||
| When self-hosting Plane for production use, it is strongly recommended to configure external database and storage. This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption. | ||
| ::: | ||
| ::: warning | ||
| When self-hosting Plane for production use, it is strongly recommended to configure external database and storage. This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption. | ||
| ::: | ||
| - `DATABASE_URL` – Connection string for your external database. | ||
| - `REDIS_URL` – Connection string for your external Redis instance. | ||
| - `AMQP_URL` – Connection string for your external RabbitMQ server. | ||
|
|
||
| 4. **Load the environment variables** | ||
|
|
||
| ```bash | ||
| set -o allexport; source <path-to variables.env>; set +o allexport; |
There was a problem hiding this comment.
Fix filename inconsistency for env file.
You download variables.env as plane.env, but later steps refer to variables.env. This mismatch will confuse users and break the copy‑paste flow.
✅ Suggested doc fix
- - `variables.env` – Stores environment variables for your deployment.
+ - `plane.env` – Stores environment variables for your deployment.
- Before deploying, edit the `variables.env` file in your preferred text editor and update the following values:
+ Before deploying, edit the `plane.env` file in your preferred text editor and update the following values:
- set -o allexport; source <path-to variables.env>; set +o allexport;
+ set -o allexport; source <path-to plane.env>; set +o allexport;🤖 Prompt for AI Agents
In `@docs/self-hosting/methods/docker-swarm.md` around lines 27 - 58, The doc
downloads the env file as plane.env but later references variables.env (e.g.,
the sed command and the load step using source <path-to variables.env>), causing
a filename mismatch; make the filenames consistent by either changing the
download command to save as variables.env or updating all subsequent references
(the sed line updating MACHINE_SIGNATURE and the load step using set -o
allexport; source ...) to use plane.env so every mention (variables.env /
plane.env) matches across the document.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary by CodeRabbit
Release Notes