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/communication.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title : Email communication
3
-
sidebarTitle: Communication
2
+
title : Email notifications
3
+
sidebarTitle: Email
4
4
description: Either during your set-up or sometime later, you will want to set SMTP settings to let your users get emails to reset passwords, onboard themselves right, and get notifications for changes, and receive exports of your data.
Copy file name to clipboardExpand all lines: self-hosting/govern/custom-domain.mdx
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,12 @@
1
1
---
2
-
title: Brand instance
2
+
title: Custom domain
3
3
description: Host your Plane instance in your custom domain. Our steps differ slightly depending on whether you are hosting on a public IP or a private/internal IP. Follow the steps listed below.
4
4
---
5
-
## Update Configuration in .env File
5
+
<Info>
6
+
In the Commercial Edition, you can set up a custom domain right during installation.
7
+
</Info>
8
+
9
+
## Update configuration in .env file
6
10
7
11
<Note>This step is mandatory for you to host Plane on a custom domain</Note>
If you are hosting Plane on a public IP, then follow the steps here. However, if you are hosting Plane on an internal IP then follow these steps.
24
28
25
-
## Set DNS A Record (For Public IP)
29
+
## Set DNS A record (for public IP)
26
30
27
31
If your server has a public IP address, you need to configure the DNS A record to point to this IP address. This allows users to access your application using your custom domain name. Here’s how to do it:
28
32
@@ -32,7 +36,7 @@ If your server has a public IP address, you need to configure the DNS A record t
32
36
- Add a new A record with the hostname set to `@` (or your subdomain if applicable) and the IP address set to your server's public IP address.
33
37
- Save the changes. It may take some time for the DNS changes to propagate.
34
38
35
-
## Configure Reverse Proxy (For Internal IP)
39
+
## Configure reverse proxy (for internal IP)
36
40
37
41
If your server is behind a firewall or router and has an internal IP address, you'll need to set up a reverse proxy to route requests from your custom domain to your server. Follow these steps:
Copy file name to clipboardExpand all lines: self-hosting/govern/database-and-storage.mdx
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,12 @@
1
1
---
2
-
title: Configure external database and storage
3
-
sidebarTitle: Database and storage
2
+
title: Configure external PostgreSQL, Redis and S3 storage
3
+
sidebarTitle: External database and storage
4
4
---
5
5
6
-
> **Edition**: Commercial
7
6
8
-
<Tip>
9
-
If you're currently on the Community edition and wish to upgrade to the Commercial edition, please refer to [Upgrade from Community](/self-hosting/upgrade-from-community).
10
-
</Tip>
7
+
The Prime CLI lets you easily configure your Commercial Edition instance, providing options to customize the PostgreSQL database, Redis, external storage, and other advanced settings.
11
8
12
-
The Prime CLI enables you to configure the Commercial edition instance, allowing customization of the PostgreSQL database, Redis, external storage, and other advanced settings.
13
-
14
-
1. From any directory on your machine, run the Prime CLI with:
9
+
1. Run the Prime CLI with ↓:
15
10
```sudo prime-cli```
16
11
17
12
2. Once the CLI is running, enter `configure`, which will guide you through a step-by-step form where you can specify the following:
@@ -21,11 +16,11 @@ The Prime CLI enables you to configure the Commercial edition instance, allowing
21
16
*Default*: `80`
22
17
23
18
-`Max file-upload size`
24
-
Set the maximum file size (in MB) that can be uploaded to your Plane app.
19
+
Set the maximum file size (in MB) that members can upload.
25
20
*Default*: `5 MB`
26
21
27
22
-`External Postgres URL`
28
-
Provide the URL of your external Postgres instance if you want to switch from the default Plane configuration.
23
+
Provide the URL of your external PostgreSQL instance if you want to switch from the default Plane configuration.
29
24
*Default*: `Postgres 15.5` in the Docker container
Copy file name to clipboardExpand all lines: self-hosting/manage/backup-restore.mdx
+50-15Lines changed: 50 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,43 @@
1
1
---
2
-
title: Backup and restore data on Community edition
3
-
sidebarTitle: Community backup and restore
2
+
title: Backup and restore data
3
+
sidebarTitle: Backup and restore
4
4
---
5
5
6
+
Backing up your data regularly helps prevent data loss and allows you to restore your system quickly if necessary. Follow these instructions to back up and restore your data using Plane’s command-line interface.
7
+
6
8
## Backup data
7
-
There would a time when you might want to backup your data from docker volumes to external storage like S3 or drives.
9
+
Create a backup of your Plane data with ↓:
10
+
```bash
11
+
sudo prime-cli backup
12
+
```
13
+
14
+
This command initiates a full backup of all critical data, storing it in the default backup location at:
15
+
```bash
16
+
/opt/plane/backups
17
+
```
18
+
Each backup file will be timestamped to ensure you can easily identify the latest or a specific backup if needed.
19
+
20
+
## Restore data
8
21
9
-
Lets again run the ./setup.sh command. You will again be prompted with the below options. This time select `7` to back data up.
22
+
You can restore your data from a previous backup with ↓:
23
+
```bash
24
+
sudo prime-cli restore
10
25
```
11
-
Select a Action you want to perform:
26
+
27
+
This command prompts the restoration process, which will overwrite the current data with the data from the most recent backup file. Ensure you have selected the correct backup before running this command, as restoring will replace your current data.
28
+
29
+
<Accordiontitle="Backup and restore on Community Edition">
30
+
31
+
## Backup data
32
+
33
+
To create a backup, start by running the setup script:
34
+
```bash
35
+
./setup.sh
36
+
```
37
+
You’ll see a menu of options—just type 7 to select "Backup Data."
38
+
39
+
```
40
+
Select an Action you want to perform:
12
41
1) Install (x86_64)
13
42
2) Start
14
43
3) Stop
@@ -20,38 +49,37 @@ Select a Action you want to perform:
20
49
21
50
Action [2]: 7
22
51
```
23
-
In response, you can find the backup folder
52
+
The system will start backing up the PostgreSQL, Redis, and upload data:
53
+
24
54
```
25
55
Backing Up plane-app_pgdata
26
56
Backing Up plane-app_redisdata
27
57
Backing Up plane-app_uploads
28
58
29
59
Backup completed successfully. Backup files are stored in /....../plane-app/backup/20240502-1120
30
60
```
31
-
This backup is stored in your machine and you can then further copy it to any storage service.
61
+
The backup files are stored locally, so you can copy them to an external storage service if needed for extra security.
32
62
****
33
63
34
-
35
64
## Restore data
65
+
Follow these steps to restore data from a backup:
36
66
37
-
When you want to restore the previously backed-up data, follow the instructions below.
67
+
1. Make sure Plane-CE is installed and started, then stop it. This ensures the necessary Docker volumes are ready.
38
68
39
-
1. Make sure that Plane-CE is installed, started, and then stopped. This ensures that the Docker volumes are created.
40
-
41
-
2. Download the restore script using the command below. We suggest downloading it in the same folder as setup.sh.
69
+
2. Use the command ↓ to download the restore script. It’s easiest to save it in the same directory as `setup.sh`.
Copy file name to clipboardExpand all lines: self-hosting/manage/prime-cli.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Prime CLI
3
3
sidebarTitle: Prime CLI
4
4
---
5
5
6
-
> **Plan**: Plane Pro, Plane One
6
+
> **Edition**: Commercial
7
7
8
8
<Warning>Update your CLI with the command `sudo prime-cli update-cli` before you download any Plane updates. The latest version of the CLI ensures your Plane upgrades happen smoothly.</Warning>
0 commit comments