From 5304bdb3feee9d2a9e8de6e6a3589d2830e64f51 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Mon, 12 Jan 2026 20:26:03 +0530 Subject: [PATCH 1/4] Change custom domain on Commercial Edition --- self-hosting/govern/custom-domain.mdx | 56 ++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/self-hosting/govern/custom-domain.mdx b/self-hosting/govern/custom-domain.mdx index 8bb862a..bc722a8 100644 --- a/self-hosting/govern/custom-domain.mdx +++ b/self-hosting/govern/custom-domain.mdx @@ -3,10 +3,64 @@ title: Custom domain sidebarTitle: Custom domain description: Host your Plane instance in your custom domain. --- +During Plane Commercial Edition installation, you configure a domain for your instance. If you need to change that domain later, whether you're moving to a production domain, switching to a different hostname, or updating your DNS configuration, this guide walks you through the process. + -With the Commercial Edition, you can set up a custom domain right during installation. If you ever need to change the domain later, just contact our support team for assistance until we ship out a feature that lets you handle domain changes yourself. +**Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`. + +**Plan for downtime** +Changing domains requires restarting Plane services. Your instance will be unavailable for a few minutes during the restart. Plan accordingly or notify your users. + + +## Check current domain configuration + +First, see which environment variables currently reference your old domain. This helps you identify exactly what needs updating. + +```bash +cat /opt/plane/plane.env | grep +``` + +**Example output:** +```env +DOMAIN_NAME=localhost +SITE_ADDRESS=http://localhost +WEB_URL=http://localhost +CORS_ALLOWED_ORIGINS=http://localhost,https://localhost +``` + +This shows you all the variables that contain your current domain. You'll update each of these in the next step. + +## Update domain in environment file + +1. Open the Plane environment configuration file: + ```bash + vim /opt/plane/plane.env + ``` + +2. Find and update these environment variables with your new domain: + + - `DOMAIN_NAME` + - `SITE_ADDRESS` + - `WEB_URL` + - `CORS_ALLOWED_ORIGINS` + + + **Configuration requirements:** + - Use the correct protocol (`http://` or `https://`) where required. + - In `CORS_ALLOWED_ORIGINS`, separate multiple entries with commas and no spaces. + + +## Restart Plane services + + Apply your configuration changes by restarting Plane: + ```bash + sudo prime-cli restart + ``` + + This process typically takes a few minutes. You'll see output indicating the status of each service as it restarts. + Our steps differ slightly depending on whether you are hosting on a public IP or a private/internal IP. Follow the steps listed below. From 9f4aa50b5ad2c38df999409e7c74f4e7e8b2b19d Mon Sep 17 00:00:00 2001 From: danciaclara Date: Mon, 12 Jan 2026 20:32:32 +0530 Subject: [PATCH 2/4] updated callout --- self-hosting/govern/custom-domain.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/self-hosting/govern/custom-domain.mdx b/self-hosting/govern/custom-domain.mdx index bc722a8..66de8ad 100644 --- a/self-hosting/govern/custom-domain.mdx +++ b/self-hosting/govern/custom-domain.mdx @@ -7,6 +7,8 @@ During Plane Commercial Edition installation, you configure a domain for your in **Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`. + +If you're running Kubernetes or another deployment method, the environment variable names are the same, but the configuration method differs based on your setup. From 48826c5858cdf67a5068fe1cabce76f8420835e0 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Mon, 12 Jan 2026 20:37:10 +0530 Subject: [PATCH 3/4] minor fixes --- self-hosting/govern/custom-domain.mdx | 45 +++++++++++++++++++++------ 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/self-hosting/govern/custom-domain.mdx b/self-hosting/govern/custom-domain.mdx index 66de8ad..b6fb4d4 100644 --- a/self-hosting/govern/custom-domain.mdx +++ b/self-hosting/govern/custom-domain.mdx @@ -43,16 +43,41 @@ This shows you all the variables that contain your current domain. You'll update 2. Find and update these environment variables with your new domain: - - `DOMAIN_NAME` - - `SITE_ADDRESS` - - `WEB_URL` - - `CORS_ALLOWED_ORIGINS` - - - **Configuration requirements:** - - Use the correct protocol (`http://` or `https://`) where required. - - In `CORS_ALLOWED_ORIGINS`, separate multiple entries with commas and no spaces. - + - **DOMAIN_NAME** + + Set this to your bare domain name without protocol: + ```env + DOMAIN_NAME=plane.company.com + ``` + + Don't include `http://` or `https://` here, just the hostname. + + - **SITE_ADDRESS** + + Set this to your full domain URL: + ```env + SITE_ADDRESS=https://plane.company.com + ``` + + Include the protocol (`https://` for SSL, `http://` if you haven't set up SSL yet). + + - **WEB_URL** + + This should match your SITE_ADDRESS: + ```env + WEB_URL=https://plane.company.com + ``` + + Again, include the full protocol. + + **CORS_ALLOWED_ORIGINS** + + List all domains that should be allowed to make cross-origin requests to your Plane instance. This typically includes both HTTP and HTTPS versions of your domain: + ```env + CORS_ALLOWED_ORIGINS=https://plane.company.com,http://plane.company.com + ``` + + Separate multiple entries with commas, no spaces. If you have multiple domains or subdomains that need access, add them all here. ## Restart Plane services From d2e611f3ef04e7eee3c3f05afd242465c4800d71 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Mon, 12 Jan 2026 20:38:40 +0530 Subject: [PATCH 4/4] coderabbit fixes --- self-hosting/govern/custom-domain.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/self-hosting/govern/custom-domain.mdx b/self-hosting/govern/custom-domain.mdx index b6fb4d4..d1ce4dd 100644 --- a/self-hosting/govern/custom-domain.mdx +++ b/self-hosting/govern/custom-domain.mdx @@ -81,12 +81,12 @@ This shows you all the variables that contain your current domain. You'll update ## Restart Plane services - Apply your configuration changes by restarting Plane: +Apply your configuration changes by restarting Plane: ```bash sudo prime-cli restart ``` - This process typically takes a few minutes. You'll see output indicating the status of each service as it restarts. +This process typically takes a few minutes. You'll see output indicating the status of each service as it restarts.