Skip to content

Commit 5304bdb

Browse files
committed
Change custom domain on Commercial Edition
1 parent af15bab commit 5304bdb

1 file changed

Lines changed: 55 additions & 1 deletion

File tree

self-hosting/govern/custom-domain.mdx

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,64 @@ title: Custom domain
33
sidebarTitle: Custom domain
44
description: Host your Plane instance in your custom domain.
55
---
6+
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.
7+
68
<Note>
7-
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.
9+
**Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`.
810
</Note>
911

12+
<Warning>
13+
**Plan for downtime**
14+
Changing domains requires restarting Plane services. Your instance will be unavailable for a few minutes during the restart. Plan accordingly or notify your users.
15+
</Warning>
16+
17+
## Check current domain configuration
18+
19+
First, see which environment variables currently reference your old domain. This helps you identify exactly what needs updating.
20+
21+
```bash
22+
cat /opt/plane/plane.env | grep <old_domain>
23+
```
24+
25+
**Example output:**
26+
```env
27+
DOMAIN_NAME=localhost
28+
SITE_ADDRESS=http://localhost
29+
WEB_URL=http://localhost
30+
CORS_ALLOWED_ORIGINS=http://localhost,https://localhost
31+
```
32+
33+
This shows you all the variables that contain your current domain. You'll update each of these in the next step.
34+
35+
## Update domain in environment file
36+
37+
1. Open the Plane environment configuration file:
38+
```bash
39+
vim /opt/plane/plane.env
40+
```
41+
42+
2. Find and update these environment variables with your new domain:
43+
44+
- `DOMAIN_NAME`
45+
- `SITE_ADDRESS`
46+
- `WEB_URL`
47+
- `CORS_ALLOWED_ORIGINS`
48+
49+
<Note>
50+
**Configuration requirements:**
51+
- Use the correct protocol (`http://` or `https://`) where required.
52+
- In `CORS_ALLOWED_ORIGINS`, separate multiple entries with commas and no spaces.
53+
</Note>
54+
55+
## Restart Plane services
56+
57+
Apply your configuration changes by restarting Plane:
58+
```bash
59+
sudo prime-cli restart
60+
```
61+
62+
This process typically takes a few minutes. You'll see output indicating the status of each service as it restarts.
63+
1064
<Accordion title="Community Edition">
1165

1266
Our steps differ slightly depending on whether you are hosting on a public IP or a private/internal IP. Follow the steps listed below.

0 commit comments

Comments
 (0)