You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: self-hosting/govern/custom-domain.mdx
+82-1Lines changed: 82 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,91 @@ title: Custom domain
3
3
sidebarTitle: Custom domain
4
4
description: Host your Plane instance in your custom domain.
5
5
---
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
+
6
8
<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.
8
12
</Note>
9
13
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.
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:
0 commit comments