Skip to content

Commit ef7e1fe

Browse files
Merge pull request #25 from makeplane/migration-guide
2 parents 05273ea + 1ecabcb commit ef7e1fe

File tree

2 files changed

+50
-29
lines changed

2 files changed

+50
-29
lines changed

mint.json

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -75,39 +75,17 @@
7575
{
7676
"group": "Authentication",
7777
"pages": [
78-
"self-hosting/govern/database-and-storage",
79-
"self-hosting/govern/instance-admin",
80-
{
81-
"group": "Authentication",
82-
"pages": [
83-
"self-hosting/govern/authentication",
84-
"self-hosting/govern/google-oauth",
85-
"self-hosting/govern/github-oauth",
86-
"self-hosting/govern/oidc-sso",
87-
"self-hosting/govern/saml-sso"
88-
]
89-
},
90-
"self-hosting/govern/communication",
91-
"self-hosting/govern/custom-domain",
92-
"self-hosting/govern/reset-password",
93-
"self-hosting/govern/private-bucket",
94-
"self-hosting/telemetry"
95-
]
96-
},
97-
{
98-
"group" : "Manage",
99-
"pages": [
100-
"self-hosting/upgrade-from-community",
101-
"self-hosting/manage/upgrade-plane",
102-
"self-hosting/manage/prime-cli",
103-
"self-hosting/manage/view-logs",
104-
"self-hosting/manage/backup-restore"
105-
106-
]
78+
"self-hosting/govern/authentication",
79+
"self-hosting/govern/google-oauth",
80+
"self-hosting/govern/github-oauth",
81+
"self-hosting/govern/oidc-sso",
82+
"self-hosting/govern/saml-sso"
83+
]
10784
},
10885
"self-hosting/govern/communication",
10986
"self-hosting/govern/custom-domain",
11087
"self-hosting/govern/reset-password",
88+
"self-hosting/govern/private-bucket",
11189
"self-hosting/telemetry"
11290
]
11391
},
@@ -117,6 +95,7 @@
11795
"self-hosting/upgrade-from-community",
11896
"self-hosting/manage/upgrade-plane",
11997
"self-hosting/manage/prime-cli",
98+
"self-hosting/manage/migrate-plane",
12099
"self-hosting/manage/view-logs",
121100
"self-hosting/manage/backup-restore"
122101
]
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Move your Plane instance to a new server • Commercial Edition
3+
sidebarTitle: Move to another server
4+
---
5+
6+
Switching to another machine is straightforward on the Commercial Edition.
7+
8+
## Prerequisites
9+
Before we dive in, ensure:
10+
11+
- You’re running Plane's Commercial Edition.
12+
- You have a different machine with our standard config to migrate to.
13+
- You understand the same domain will be used to host the app as the current machine.
14+
15+
## Steps
16+
1. **Delink licenses**
17+
Log in to Plane on your current server. Head to each paid workspace like One or Pro and [delink the licenses](https://docs.plane.so/workspaces-and-users/upgrade-plan#delink-license-key). This will free up the licenses for activation on your new server. Ideally, you have just one paid workspace.
18+
19+
2. **Backup data**
20+
Create a backup of your Plane instance with ↓:
21+
```bash
22+
prime-cli backup
23+
```
24+
This command will generate a backup file in the path: `/opt/plane/backup`.
25+
26+
3. **Set up Plane on the new server**
27+
Follow the [installation guide](/self-hosting/methods/docker-compose#install-plane) to deploy Plane on the new instance.
28+
29+
4. **Transfer backup files**
30+
Copy the backup folder from the old server, created in step 2, to the new server. Place the backup in the folder `/opt/plane`.
31+
32+
5. **Restore data**
33+
On the new server, restore your data with ↓:
34+
```bash
35+
prime-cli restore
36+
````
37+
Follow the prompts during the restore process to make sure everything is set up correctly.
38+
39+
6. **Reactivate license**
40+
Finally, [reactivate your license keys](https://docs.plane.so/workspaces-and-users/upgrade-plan#self-hosted-only) on the new instance.
41+
42+
This should get your Plane instance up and running on the new server.

0 commit comments

Comments
 (0)