Skip to content

Commit ae71ee5

Browse files
authored
Merge pull request #12 from makeplane/instance-admin-email
Added new configure page
2 parents c586ff9 + cc9e16e commit ae71ee5

File tree

4 files changed

+55
-2
lines changed

4 files changed

+55
-2
lines changed

mint.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@
7070
]
7171
},
7272
{
73-
"group" : "Configure instance",
73+
"group" : "Configure",
7474
"pages": [
75+
"self-hosting/govern/database-and-storage",
7576
"self-hosting/govern/instance-admin",
7677
{
7778
"group": "Authentication",
@@ -90,7 +91,7 @@
9091
]
9192
},
9293
{
93-
"group" : "Manage instance",
94+
"group" : "Manage",
9495
"pages": [
9596
"self-hosting/upgrade-from-community",
9697
"self-hosting/manage/upgrade-plane",
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Configure external database and storage
3+
sidebarTitle: Database and storage
4+
---
5+
6+
> **Edition**: Commercial
7+
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>
11+
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:
15+
```sudo prime-cli```
16+
17+
2. Once the CLI is running, enter `configure`, which will guide you through a step-by-step form where you can specify the following:
18+
19+
- `Listening port`
20+
Define the port for the built-in reverse proxy.
21+
*Default*: `80`
22+
23+
- `Max file-upload size`
24+
Set the maximum file size (in MB) that can be uploaded to your Plane app.
25+
*Default*: `5 MB`
26+
27+
- `External Postgres URL`
28+
Provide the URL of your external Postgres instance if you want to switch from the default Plane configuration.
29+
*Default*: `Postgres 15.5` in the Docker container
30+
31+
- `External Redis URL`
32+
Specify the URL of your external Redis instance to override the default Redis configuration.
33+
*Default*: `Redis 7.2.4`
34+
35+
- `External storage`
36+
Switch to your own storage by entering your AWS S3 credentials. Use the following format:
37+
- AWS Access Key ID
38+
- AWS Secret Access Key
39+
- AWS S3 Bucket Name
40+
41+
*Default*: `MinIO`
42+
3. After confirming your choices, your instance will automatically restart with the updated configuration.
43+

self-hosting/govern/instance-admin.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ God Mode features a few screens as shown below.
4747

4848
Soon, we will introduce God Mode for our Cloud users as well so they can manage their workspaces better. To get notified about this, [sign up here](https://ece39166.sibforms.com/serve/MUIFANgaMWIARsq1n0lMNrch19pdY2HJm9FkSXAeq1DrCoXJBmO9Yq6SPgtzu7rL0lQBmCvvz2A2arVl5WaDxYu6YhNW4PKNAis0DMXmpRnwm5633BvXqIYILqZuyqYiGS7_QjJ0Ozh4R2uctd8RwiiTLSHWpnV2njQt6DPV5cVr8FH3K-TouNAlBScOJxbCpjj8fYo2ULsEJeAL).
4949

50+
## Add instance admin
51+
To grant a user full administrative access (including God mode) to your self-hosted Plane instance, you'll need to assign them the Instance Admin role. Instance admins have unrestricted control over all configurations and settings within the instance.
52+
53+
To promote an existing user to Instance Admin, execute the following command in your terminal:
54+
```bash
55+
docker exec <backend_container_name> /bin/bash -c "python manage.py create_instance_admin <user_email>"
56+
```
57+
Ensure that the provided email matches the user's registered account. This command will instantly elevate their privileges to full administrative access.
5058

5159
## FAQs
5260
<AccordionGroup>

self-hosting/upgrade-from-community.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Upgrade from Community to Commercial Edition
33
sidebarTitle: Upgrade from Community
44
---
5+
The Commercial edition comes with the free plan and the flexibility to upgrade to a paid plan at any point.
56

67
<Warning>
78
Follow the instructions below first all the way to the end of the section **Restore data**.

0 commit comments

Comments
 (0)