Skip to content

Plane-CE: Update environment variable names for clarity and consistency in documentation in Plane CE Docs #139

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.

Sign up for GitHub

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
sriramveeraghanta merged 5 commits into from
Aug 27, 2025
Merged

Plane-CE: Update environment variable names for clarity and consistency in documentation in Plane CE Docs #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d0e96ed
Brand refresh #132
sriramveeraghanta Aug 1, 2025
77b6ae8
GitHub Enterprise Server and brand color updates #134
sriramveeraghanta Aug 1, 2025
01284e3
Merge pull request #136 from makeplane/preview
sriramveeraghanta Aug 4, 2025
5c7ba7e
Update environment variable names for clarity and consistency in docu…
akshat5302 Aug 27, 2025
58d5826
Merge branch 'master' of https://github.com/makeplane/developer-docs …
akshat5302 Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion self-hosting/govern/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,8 @@ The environment configuration file is located at:
| **WEB_URL** | The complete base URL for the web application including protocol. Essential for email links and integrations. | `http://${APP_DOMAIN}` |
| **CORS_ALLOWED_ORIGINS** | Comma-separated list of origins allowed to make cross-origin requests to your API. | `http://${APP_DOMAIN}` |
| **DEBUG** | Toggles debug mode for verbose logging. Set to `1` to enable, `0` to disable. Not recommended in production as it may expose sensitive information. | `0` |
| **NGINX_PORT** | Port for HTTP traffic. The primary port your users will connect to. | `80` |
| **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` |

### Scaling and performance

Expand Down
7 changes: 4 additions & 3 deletions self-hosting/methods/docker-compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,10 @@ If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so
This will create a folder `plane-app` or `plane-app-preview` (in case of preview deployment) and will download the `docker-compose.yaml` and `plane.env` files.
7. Enter `8` to exit.
8. Set up the environment variables. You can use any text editor to edit this file. Below are the most importants keys you must refer to:
- `NGINX_PORT`: This is set to `80` by default. Make sure the port you choose to use is not preoccupied. For example, `NGINX_PORT=8080`
- `WEB_URL`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with NGINX\_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 NGINX\_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 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`.
Comment on lines +104 to +107
Copy link

@coderabbitai coderabbitai bot Aug 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ 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.

Suggested change
- `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."

9. Run the following command to continue with the setup.
```bash
./setup.sh
Expand Down