Skip to content

Commit a96bc5a

Browse files
Change custom domain on Commercial edition #178
2 parents f27b2ce + d2dc183 commit a96bc5a

File tree

1 file changed

+82
-1
lines changed

1 file changed

+82
-1
lines changed

self-hosting/govern/custom-domain.mdx

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,91 @@ 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`.
10+
11+
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.
812
</Note>
913

14+
<Warning>
15+
**Plan for downtime**
16+
Changing domains requires restarting Plane services. Your instance will be unavailable for a few minutes during the restart. Plan accordingly or notify your users.
17+
</Warning>
18+
19+
## Check current domain configuration
20+
21+
First, see which environment variables currently reference your old domain. This helps you identify exactly what needs updating.
22+
23+
```bash
24+
cat /opt/plane/plane.env | grep <old_domain>
25+
```
26+
27+
**Example output:**
28+
```env
29+
DOMAIN_NAME=localhost
30+
SITE_ADDRESS=http://localhost
31+
WEB_URL=http://localhost
32+
CORS_ALLOWED_ORIGINS=http://localhost,https://localhost
33+
```
34+
35+
This shows you all the variables that contain your current domain. You'll update each of these in the next step.
36+
37+
## Update domain in environment file
38+
39+
1. Open the Plane environment configuration file:
40+
```bash
41+
vim /opt/plane/plane.env
42+
```
43+
44+
2. Find and update these environment variables with your new domain:
45+
46+
- **DOMAIN_NAME**
47+
48+
Set this to your bare domain name without protocol:
49+
```env
50+
DOMAIN_NAME=plane.company.com
51+
```
52+
53+
Don't include `http://` or `https://` here, just the hostname.
54+
55+
- **SITE_ADDRESS**
56+
57+
Set this to your full domain URL:
58+
```env
59+
SITE_ADDRESS=https://plane.company.com
60+
```
61+
62+
Include the protocol (`https://` for SSL, `http://` if you haven't set up SSL yet).
63+
64+
- **WEB_URL**
65+
66+
This should match your SITE_ADDRESS:
67+
```env
68+
WEB_URL=https://plane.company.com
69+
```
70+
71+
Again, include the full protocol.
72+
73+
**CORS_ALLOWED_ORIGINS**
74+
75+
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:
76+
```env
77+
CORS_ALLOWED_ORIGINS=https://plane.company.com,http://plane.company.com
78+
```
79+
80+
Separate multiple entries with commas, no spaces. If you have multiple domains or subdomains that need access, add them all here.
81+
82+
## Restart Plane services
83+
84+
Apply your configuration changes by restarting Plane:
85+
```bash
86+
sudo prime-cli restart
87+
```
88+
89+
This process typically takes a few minutes. You'll see output indicating the status of each service as it restarts.
90+
1091
<Accordion title="Community Edition">
1192

1293
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)