Plane-CE: Update environment variable names for clarity and consistency in documentation in Plane CE Docs #139
Conversation
Fix callback urls in GitHub enterprise edition
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughDocumentation updates adjust environment variable names and defaults for self-hosting: replacing NGINX_PORT with LISTEN_HTTP_PORT and LISTEN_HTTPS_PORT, revising WEB_REPLICAS and GUNICORN_WORKERS descriptions in Community edition, and updating Docker Compose guidance and examples to reference the new port variables. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
self-hosting/govern/environment-variables.mdx (1)
60-60: Typo: SITE_ADDRES → SITE_ADDRESS.User-facing variable name; fix to avoid misconfiguration.
-| **SITE_ADDRES** | The domain name and port required by Caddy for serving your Plane instance. This determines how Caddy will handle incoming requests. | `localhost:80` | +| **SITE_ADDRESS** | The domain name and port required by Caddy for serving your Plane instance. This determines how Caddy will handle incoming requests. | `localhost:80` |
🧹 Nitpick comments (3)
self-hosting/methods/docker-compose.mdx (1)
104-105: Minor wording: “not preoccupied” → “not in use”; mention firewall.Small clarity bump for readers.
- - `LISTEN_HTTP_PORT`: This is set to `80` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTP_PORT=8080` - - `LISTEN_HTTPS_PORT`: This is set to `443` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTPS_PORT=4430` + - `LISTEN_HTTP_PORT`: Default `80`. Ensure the port you choose is not in use and allowed in your firewall. Example: `LISTEN_HTTP_PORT=8080` + - `LISTEN_HTTPS_PORT`: Default `443`. Ensure the port you choose is not in use and allowed in your firewall. Example: `LISTEN_HTTPS_PORT=4430`self-hosting/govern/environment-variables.mdx (2)
169-170: Add cross-reference to WEB_URL/CORS and gateway behavior for CE ports.Readers benefit from knowing these are the external ports and should align with WEB_URL/CORS.
-| **LISTEN_HTTP_PORT** | Port for HTTP traffic. The primary port your users will connect to. | `80` | -| **LISTEN_HTTPS_PORT** | Port for HTTPS traffic. The primary port your users will connect to. | `443` | +| **LISTEN_HTTP_PORT** | External HTTP port exposed by the gateway (Caddy). Align WEB_URL/CORS with this when using `http`. | `80` | +| **LISTEN_HTTPS_PORT** | External HTTPS port exposed by the gateway (Caddy). Align WEB_URL/CORS with this when using `https`. | `443` |
41-41: Confirm GUNICORN_WORKERS default for Commercial section.CE defaults to 1 (Line 183). Commercial lists default
2(Line 41). If intentional, add a brief note explaining the difference to reduce confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
self-hosting/govern/environment-variables.mdx(1 hunks)self-hosting/methods/docker-compose.mdx(1 hunks)
🔇 Additional comments (1)
self-hosting/methods/docker-compose.mdx (1)
104-107: No lingering references toNGINX_PORTfound.
Ranrg -n -C1 '\bNGINX_PORT\b|nginx_port|NGINX PORT' -g '!**/node_modules/**' -g '!**/dist/**'from the repo root and confirmed zero matches, so all stale references have been removed across the docs.
| - `LISTEN_HTTP_PORT`: This is set to `80` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTP_PORT=8080` | ||
| - `LISTEN_HTTPS_PORT`: This is set to `443` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTPS_PORT=4430` | ||
| - `WEB_URL`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with LISTEN_HTTP_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`. | ||
| - `CORS_ALLOWED_ORIGINS`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with LISTEN_HTTP_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify WEB_URL/CORS examples to match selected protocol/port variables.
"along with LISTEN_HTTP_PORT" is incorrect when the scheme is https. Use the appropriate port variable per scheme and fix examples.
- - `WEB_URL`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with LISTEN_HTTP_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`.
- - `CORS_ALLOWED_ORIGINS`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with LISTEN_HTTP_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`.
+ - `WEB_URL`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use, and include the matching port variable for the scheme you select — `LISTEN_HTTP_PORT` for `http`, or `LISTEN_HTTPS_PORT` for `https`. For example: `http://plane.example.com:8080` or `https://plane.example.com:4430`.
+ - `CORS_ALLOWED_ORIGINS`: This is set to `http://localhost` by default. Change this to the FQDN(s) you plan to use, including the corresponding port for the chosen scheme. For example: `http://plane.example.com:8080` or `https://plane.example.com:4430`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - `LISTEN_HTTP_PORT`: This is set to `80` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTP_PORT=8080` | |
| - `LISTEN_HTTPS_PORT`: This is set to `443` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTPS_PORT=4430` | |
| - `WEB_URL`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with LISTEN_HTTP_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`. | |
| - `CORS_ALLOWED_ORIGINS`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with LISTEN_HTTP_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`. | |
| - `LISTEN_HTTP_PORT`: This is set to `80` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTP_PORT=8080` | |
| - `LISTEN_HTTPS_PORT`: This is set to `443` by default. Make sure the port you choose to use is not preoccupied. For example, `LISTEN_HTTPS_PORT=4430` | |
| - `WEB_URL`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use, and include the matching port variable for the scheme you select — `LISTEN_HTTP_PORT` for `http`, or `LISTEN_HTTPS_PORT` for `https`. For example: `http://plane.example.com:8080` or `https://plane.example.com:4430`. | |
| - `CORS_ALLOWED_ORIGINS`: This is set to `http://localhost` by default. Change this to the FQDN(s) you plan to use, including the corresponding port for the chosen scheme. For example: `http://plane.example.com:8080` or `https://plane.example.com:4430`. |
🤖 Prompt for AI Agents
In self-hosting/methods/docker-compose.mdx around lines 104 to 107, the docs
instruct users to change WEB_URL and CORS_ALLOWED_ORIGINS "along with
LISTEN_HTTP_PORT" even when using an https scheme; update the text and examples
so that HTTPS examples reference the LISTEN_HTTPS_PORT variable and HTTP
examples reference LISTEN_HTTP_PORT, e.g. show
https://plane.example.com:LISTEN_HTTPS_PORT (or concrete port like :4430) for
HTTPS and http://[IP-ADDRESS]:LISTEN_HTTP_PORT (or :8080) for HTTP, and adjust
the explanatory sentence to say "along with the corresponding LISTEN_HTTP_PORT
or LISTEN_HTTPS_PORT depending on the scheme."
…into remove-unused-community-vars
Summary by CodeRabbit