From 5ef344886cbdcfb7f9c119080000f282cbe7bcdf Mon Sep 17 00:00:00 2001 From: Sriram Veeraghanta Date: Fri, 21 Aug 2026 00:57:54 +0530 Subject: [PATCH] fix(developer-docs): use plain KEY=VALUE format in plane.env example `docker compose --env-file` does not support shell `export` syntax, so the air-gapped `plane.env` snippet now uses plain `KEY=VALUE` lines. Replace the `$(uuidgen)` command substitution with a literal placeholder and a note telling users to run `uuidgen` and paste the output as `MACHINE_SIGNATURE`. Ports makeplane/developer-docs#318. Claude-Session: https://claude.ai/code/session_01QbJp4uYoTdvYsBLeRfSJv1 --- .../self-hosting/methods/airgapped-edition.md | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/apps/developer-docs/docs/self-hosting/methods/airgapped-edition.md b/apps/developer-docs/docs/self-hosting/methods/airgapped-edition.md index efc7ec57..622eb783 100644 --- a/apps/developer-docs/docs/self-hosting/methods/airgapped-edition.md +++ b/apps/developer-docs/docs/self-hosting/methods/airgapped-edition.md @@ -66,16 +66,25 @@ Consider these alternatives: Edit the `plane.env` file to configure your deployment: ```bash - # Generate a unique machine signature - export MACHINE_SIGNATURE=$(uuidgen) - # Set your domain - export DOMAIN_NAME=plane.yourcompany.com - export WEB_URL=https://plane.yourcompany.com - export CORS_ALLOWED_ORIGINS=https://plane.yourcompany.com - export SITE_ADDRESS=https://plane.yourcompany.com + DOMAIN_NAME=plane.yourcompany.com + WEB_URL=https://plane.yourcompany.com + CORS_ALLOWED_ORIGINS=https://plane.yourcompany.com + SITE_ADDRESS=https://plane.yourcompany.com + + # Paste the generated UUID here (see note below) + MACHINE_SIGNATURE=your-uuid-here ``` + :::info + **Generating `MACHINE_SIGNATURE`:** Run the following command in your terminal to generate a unique UUID, then paste the output as the value of `MACHINE_SIGNATURE` in `plane.env`: + + ```bash + uuidgen + ``` + + ::: + **Update image references** in `docker-compose.yml` to point to your private registry: ```yaml