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
@@ -14,127 +14,128 @@ The Prime CLI lets you easily configure your Commercial Edition instance, provid
14
14
15
15
1. Run the Prime CLI with ↓:
16
16
17
-
`sudo prime-cli`
17
+
`sudo prime-cli`
18
18
19
19
2. Once the CLI is running, enter `configure`, which will guide you through a step-by-step form where you can specify the following:
20
-
-`Listening port`
21
-
Define the port for the built-in reverse proxy.
22
-
_Default_: `80`
23
-
24
-
-`Max file-upload size`
25
-
Set the maximum file size (in MB) that members can upload.
26
-
_Default_: `5 MB`
27
-
28
-
-`External Postgres URL`
29
-
Provide the URL of your external PostgreSQL instance if you want to switch from the default Plane configuration.
30
-
_Default_: `Postgres 15.5` in the Docker container.
31
-
32
-
::: warning
33
-
Don’t use a database on your local machine. If you use `localhost` in the URL, it won’t work. Make sure to use a database hosted on a network-accessible server.
34
-
35
-
Avoid using special characters in your PostgreSQL password.
36
-
:::
37
-
38
-
-`External Redis URL`
39
-
Specify the URL of your external Redis instance to override the default Redis configuration.
40
-
_Default_: `Redis 7.2.4`
41
-
42
-
-`External storage`
43
-
Plane currently supports only S3 compatible storages.
44
-
_Default_: `MinIO`
45
-
46
-
1. Ensure your IAM user has the following permissions on your S3 bucket.
47
-
- **s3:GetObject**
48
-
To access the objects.
49
-
- **s3:PutObject**
50
-
To upload new assets using the presigned url.
51
-
2. Configure the CORS policy on your bucket to enable presigned uploads. Use the example policy below, making sure to replace `<YOUR_DOMAIN>` with your actual domain.
52
-
```
53
-
[
54
-
{
55
-
"AllowedHeaders": [
56
-
"*"
57
-
],
58
-
"AllowedMethods": [
59
-
"GET",
60
-
"POST",
61
-
"PUT",
62
-
"DELETE",
63
-
"HEAD"
64
-
],
65
-
"AllowedOrigins": [
66
-
"<YOUR_DOMAIN>",
67
-
],
68
-
"ExposeHeaders": [
69
-
"ETag",
70
-
"x-amz-server-side-encryption",
71
-
"x-amz-request-id",
72
-
"x-amz-id-2"
73
-
],
74
-
"MaxAgeSeconds": 3000
75
-
}
76
-
]
77
-
```
78
-
3. Switch to your external storage by providing the following values:
79
-
- S3 access key ID
80
-
- S3 secret access key
81
-
- S3 bucket name
82
-
- S3 region
83
-
- S3 endpoint URL
20
+
21
+
-`Listening port`
22
+
Define the port for the built-in reverse proxy.
23
+
_Default_: `80`
24
+
25
+
-`Max file-upload size`
26
+
Set the maximum file size (in MB) that members can upload.
27
+
_Default_: `5 MB`
28
+
29
+
-`External Postgres URL`
30
+
Provide the URL of your external PostgreSQL instance if you want to switch from the default Plane configuration.
31
+
_Default_: `Postgres 15.5` in the Docker container.
32
+
33
+
::: warning
34
+
Don’t use a database on your local machine. If you use `localhost` in the URL, it won’t work. Make sure to use a database hosted on a network-accessible server.
35
+
36
+
Avoid using special characters in your PostgreSQL password.
37
+
:::
38
+
39
+
-`External Redis URL`
40
+
Specify the URL of your external Redis instance to override the default Redis configuration.
41
+
_Default_: `Redis 7.2.4`
42
+
43
+
-`External storage`
44
+
Plane currently supports only S3 compatible storages.
45
+
_Default_: `MinIO`
46
+
1. Ensure your IAM user has the following permissions on your S3 bucket.
47
+
-**s3:GetObject**
48
+
To access the objects.
49
+
-**s3:PutObject**
50
+
To upload new assets using the presigned url.
51
+
2. Configure the CORS policy on your bucket to enable presigned uploads. Use the example policy below, making sure to replace `<YOUR_DOMAIN>` with your actual domain.
52
+
```
53
+
[
54
+
{
55
+
"AllowedHeaders": [
56
+
"*"
57
+
],
58
+
"AllowedMethods": [
59
+
"GET",
60
+
"POST",
61
+
"PUT",
62
+
"DELETE",
63
+
"HEAD"
64
+
],
65
+
"AllowedOrigins": [
66
+
"<YOUR_DOMAIN>",
67
+
],
68
+
"ExposeHeaders": [
69
+
"ETag",
70
+
"x-amz-server-side-encryption",
71
+
"x-amz-request-id",
72
+
"x-amz-id-2"
73
+
],
74
+
"MaxAgeSeconds": 3000
75
+
}
76
+
]
77
+
```
78
+
79
+
3. Switch to your external storage by providing the following values:
80
+
- S3 access key ID
81
+
- S3 secret access key
82
+
- S3 bucket name
83
+
- S3 region
84
+
- S3 endpoint URL
84
85
85
86
3. After confirming your choices, your instance will automatically restart with the updated configuration.
86
87
87
88
::: details Community Edition
88
89
89
-
To configure external Postgres, Redis, and S3 storage for the Plane Community Edition, you’ll need to adjust several environment variables in the plane.env file. Follow this guide to set up each component using the correct values for your external services.
90
-
91
-
1. Open the `plane.env` file on your server where Plane is installed.
92
-
93
-
2. In the **DB SETTINGS** section, update the variables to connect to your external Postgres instance:
94
-
95
-
```bash
96
-
# DB SETTINGS
97
-
PGHOST=your-external-postgres-host # Replace with the hostname or IP address of your Postgres server.
98
-
PGDATABASE= # Leave blank when using external database.
99
-
POSTGRES_USER=your-postgres-username # The username to access Postgres.
100
-
POSTGRES_PASSWORD=your-postgres-password # Password for the Postgres user.
101
-
POSTGRES_DB=your-database-name # The name of the database Plane should connect to.
102
-
POSTGRES_PORT=5432 # Port where Postgres is accessible (usually 5432).
103
-
PGDATA=/var/lib/postgresql/data # No need to change this for external Postgres.
104
-
DATABASE_URL= # Leave this empty if you're providing values for the variables above. If you choose to use the DATABASE_URL, you can leave all the other database-related variables empty.
105
-
```
106
-
107
-
::: warning
108
-
Don’t use a database on your local machine. If you use `localhost`in the URL, it won’t work. Make sure to use a database hosted on a network-accessible server.
109
-
110
-
Avoid using special characters in your PostgreSQL password.
111
-
:::
112
-
113
-
3. In the **REDIS SETTINGS** section, update the variables to connect to your external Redis instance:
114
-
115
-
```bash
116
-
# REDIS SETTINGS
117
-
REDIS_HOST=your-external-redis-host # Hostname or IP of the Redis server.
118
-
REDIS_PORT=6379 # Port where Redis is accessible (default is 6379).
119
-
REDIS_URL= # Leave this empty if you're providing values for the variables above. If you choose to use the REDIS_URL, you can leave all the other redis-related variables empty.
120
-
```
121
-
122
-
4. In the **DATA STORE SETTINGS** section, update the variables for any S3-compatible storage:
123
-
```bash
124
-
# DATA STORE SETTINGS
125
-
USE_MINIO=0 # Set to 0 if using an external S3, 1 if using MinIO (default).
126
-
AWS_REGION=your-s3-region # For AWS, set the region, e.g., "us-west-1".
127
-
AWS_ACCESS_KEY_ID=your-s3-access-key # Access key for S3.
128
-
AWS_SECRET_ACCESS_KEY=your-s3-secret-key # Secret key for S3.
129
-
AWS_S3_ENDPOINT_URL=https://your-s3-endpoint # URL for S3 API endpoint (e.g., "https://s3.amazonaws.com" for AWS).
130
-
AWS_S3_BUCKET_NAME=your-s3-bucket-name # Name of the S3 bucket for storing Plane data.
131
-
MINIO_ROOT_USER= # Leave blank when using external S3.
132
-
MINIO_ROOT_PASSWORD= # Leave blank when using external S3.
133
-
BUCKET_NAME= # Leave blank when using external S3.
134
-
FILE_SIZE_LIMIT=5242880 # Set maximum file upload size in bytes (5MB here).
135
-
```
136
-
5. Save your changes to the `plane.env` file.
137
-
138
-
6. Restart Plane services to apply the new settings using the `setup.sh` script.
90
+
To configure external Postgres, Redis, and S3 storage for the Plane Community Edition, you’ll need to adjust several environment variables in the plane.env file. Follow this guide to set up each component using the correct values for your external services.
91
+
92
+
1. Open the `plane.env` file on your server where Plane is installed.
93
+
94
+
2. In the **DB SETTINGS** section, update the variables to connect to your external Postgres instance:
95
+
96
+
```bash
97
+
# DB SETTINGS
98
+
PGHOST=your-external-postgres-host # Replace with the hostname or IP address of your Postgres server.
99
+
PGDATABASE= # Leave blank when using external database.
100
+
POSTGRES_USER=your-postgres-username # The username to access Postgres.
101
+
POSTGRES_PASSWORD=your-postgres-password # Password for the Postgres user.
102
+
POSTGRES_DB=your-database-name # The name of the database Plane should connect to.
103
+
POSTGRES_PORT=5432 # Port where Postgres is accessible (usually 5432).
104
+
PGDATA=/var/lib/postgresql/data # No need to change this for external Postgres.
105
+
DATABASE_URL= # Leave this empty if you're providing values for the variables above. If you choose to use the DATABASE_URL, you can leave all the other database-related variables empty.
106
+
```
107
+
108
+
::: warning
109
+
Don’t use a database on your local machine. If you use `localhost`in the URL, it won’t work. Make sure to use a database hosted on a network-accessible server.
110
+
111
+
Avoid using special characters in your PostgreSQL password.
112
+
:::
113
+
114
+
3. In the **REDIS SETTINGS** section, update the variables to connect to your external Redis instance:
115
+
116
+
```bash
117
+
# REDIS SETTINGS
118
+
REDIS_HOST=your-external-redis-host # Hostname or IP of the Redis server.
119
+
REDIS_PORT=6379 # Port where Redis is accessible (default is 6379).
120
+
REDIS_URL= # Leave this empty if you're providing values for the variables above. If you choose to use the REDIS_URL, you can leave all the other redis-related variables empty.
121
+
```
122
+
123
+
4. In the **DATA STORE SETTINGS** section, update the variables for any S3-compatible storage:
124
+
```bash
125
+
# DATA STORE SETTINGS
126
+
USE_MINIO=0 # Set to 0 if using an external S3, 1 if using MinIO (default).
127
+
AWS_REGION=your-s3-region # For AWS, set the region, e.g., "us-west-1".
128
+
AWS_ACCESS_KEY_ID=your-s3-access-key # Access key for S3.
129
+
AWS_SECRET_ACCESS_KEY=your-s3-secret-key # Secret key for S3.
130
+
AWS_S3_ENDPOINT_URL=https://your-s3-endpoint # URL for S3 API endpoint (e.g., "https://s3.amazonaws.com" for AWS).
131
+
AWS_S3_BUCKET_NAME=your-s3-bucket-name # Name of the S3 bucket for storing Plane data.
132
+
MINIO_ROOT_USER= # Leave blank when using external S3.
133
+
MINIO_ROOT_PASSWORD= # Leave blank when using external S3.
134
+
BUCKET_NAME= # Leave blank when using external S3.
135
+
FILE_SIZE_LIMIT=5242880 # Set maximum file upload size in bytes (5MB here).
136
+
```
137
+
5. Save your changes to the `plane.env` file.
138
+
139
+
6. Restart Plane services to apply the new settings using the `setup.sh` script.
Users can reset their password through the terminal of the Plane application. You need to login to backend docker container and run the below command for resetting a user’s password.
10
10
11
11
1. Get the container id for **plane-api**.
12
-
13
-
```bash
14
-
docker ps
15
-
```
12
+
```bash
13
+
docker ps
14
+
```
16
15
17
16
2. Log in to the container.
18
-
19
-
```bash
20
-
docker exec -it <container_id> /bin/sh
21
-
```
17
+
```bash
18
+
docker exec -it <container_id> /bin/sh
19
+
```
22
20
23
21
3. Run the reset password command.
24
-
`bash
25
-
python manage.py reset_password <email>
26
-
`
27
-
::: tip
28
-
The email should be of an already existing user on the Plane application. If the email is not attached to any user the command will throw an error.
29
-
:::
22
+
```bash
23
+
python manage.py reset_password <email>
24
+
```
25
+
::: tip
26
+
The email should be of an already existing user on the Plane application. If the email is not attached to any user the command will throw an error.
Copy file name to clipboardExpand all lines: docs/self-hosting/manage/migrate-plane.md
+21-18Lines changed: 21 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,33 +23,36 @@ If you need to change your domain during migration, contact our support team for
23
23
## Steps
24
24
25
25
1.**Delink licenses**
26
-
Log in to Plane on your current server. Head to each paid workspace like Pro or Business and [delink the licenses](/self-hosting/manage/manage-licenses/activate-pro-and-business#delink-license-key). This will free up the licenses for activation on your new server. Ideally, you have just one paid workspace.
26
+
Log in to Plane on your current server. Head to each paid workspace like Pro or Business and [delink the licenses](/self-hosting/manage/manage-licenses/activate-pro-and-business#delink-license-key). This will free up the licenses for activation on your new server. Ideally, you have just one paid workspace.
27
27
28
28
2.**Backup data**
29
-
Create a backup of your Plane instance with ↓:
30
-
`bash
31
-
prime-cli backup
32
-
`
33
-
This command will generate a backup file in the path: `/opt/plane/backups`.
29
+
Create a backup of your Plane instance with ↓:
30
+
```bash
31
+
prime-cli backup
32
+
```
33
+
34
+
This command will generate a backup file in the path: `/opt/plane/backups`.
34
35
35
-
::: warning
36
-
**Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`.
37
-
:::
36
+
::: warning
37
+
**Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`.
38
+
:::
38
39
39
40
3.**Set up Plane on the new server**
40
-
Follow the [installation guide](/self-hosting/methods/docker-compose#install-plane) to deploy Plane on the new instance.
41
+
Follow the [installation guide](/self-hosting/methods/docker-compose#install-plane) to deploy Plane on the new instance.
41
42
42
43
4.**Transfer backup files**
43
-
Copy the `backups` folder from the old server, created in step 2, to the new server. Place the backup in the folder `/opt/plane`.
44
+
Copy the `backups` folder from the old server, created in step 2, to the new server. Place the backup in the folder `/opt/plane`.
44
45
45
46
5.**Restore data**
46
-
On the new server, restore your data with ↓:
47
-
```bash
48
-
prime-cli restore
49
-
````
50
-
Follow the prompts during the restore process to make sure everything is set up correctly.
47
+
On the new server, restore your data with ↓:
48
+
49
+
```bash
50
+
prime-cli restore
51
+
```
52
+
53
+
Follow the prompts during the restore process to make sure everything is set up correctly.
51
54
52
55
6.**Reactivate license**
53
-
Finally, [reactivate your license keys](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) on the new instance.
56
+
Finally, [reactivate your license keys](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) on the new instance.
54
57
55
-
This should get your Plane instance up and running on the new server.
58
+
This should get your Plane instance up and running on the new server.
0 commit comments