Skip to content

Commit 3c4d39b

Browse files
Dancia ClaraDancia Clara
Dancia Clara
authored and
Dancia Clara
committed
updated images and oher fixes
1 parent deb39c9 commit 3c4d39b

File tree

10 files changed

+313
-314
lines changed

10 files changed

+313
-314
lines changed

‎images/upgrade-to-paid-plan/activate-license-key.webp‎

-2.15 KB
Loading

‎images/upgrade-to-paid-plan/billing-plane-one.webp‎

-1.33 KB
Loading

‎images/upgrade-to-paid-plan/workspace-settings.webp‎

24.8 KB
Loading

‎mint.json‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,17 +86,12 @@
8686
"pages": [
8787
"self-hosting/manage/backup-restore",
8888
"self-hosting/manage/upgrade-plane",
89-
"self-hosting/manage/view-logs"
89+
"self-hosting/manage/view-logs",
90+
"self-hosting/manage/prime-cli"
9091
]
9192
},
92-
{
93-
"group" : "Manage plans",
94-
"pages": [
95-
"self-hosting/manage-plans/prime-client",
96-
"self-hosting/manage-plans/prime-cli",
97-
"self-hosting/manage-plans/upgrade-from-community"
98-
]
99-
}
93+
"self-hosting/upgrade-from-community",
94+
"self-hosting/prime-client"
10095
]
10196
},
10297
{

self-hosting/manage-plans/prime-cli.mdx renamed to self-hosting/manage/prime-cli.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
2-
title: Manage your instance
2+
title: Prime CLI
33
sidebarTitle: Prime CLI
44
---
5+
6+
> **Plan**: Plane Pro, Plane One
7+
58
<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>
69

710
The Prime CLI is our own command-line interface to help you install, upgrade, and manage your instance without being a pro at Docker. -

‎self-hosting/manage/upgrade-plane.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
title: Update Plane
33
---
44

5+
This page provides steps to update Plane to the latest version on your self-hosted instance.
6+
## Prerequisites
7+
Create a backup of the Plane instance. See [Backup data](/self-hosting/manage/backup-restore#backup-data) (Recommended)
58
## Update Plane version
6-
79
<Note> This upgrade guide is for v0.14.0 and above. If your Plane version is v0.13.2 than v0.14.0 then follow the guide [here](#upgrading-from-v0-13-2-to-v0-14-0) to get to v0.14.0 and then continue with further upgrades.</Note>
810
It is always advised to keep Plane up to date with the latest release.
911

‎self-hosting/methods/docker-compose.mdx‎

Lines changed: 71 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,54 @@ title: Docker
44

55
This guide shows you the steps to deploy a self-hosted instance of Plane using Docker.
66

7-
<Tabs>
8-
<Tab title="ENTERPRISE • Recommended">
9-
The Enterprise edition comes with a **free plan** and the flexibility to upgrade to a paid plan at any point.
10-
### Prerequisites
11-
12-
- A virtual or on-prem machine with atleast 2 vCPUs and 4 GB RAM
13-
- `x64` AKA `AMD 64` or `AArch 64` AKA `ARM 64` CPUs
14-
- Supported operating systems:
15-
- Ubuntu
16-
- Debian
17-
- CentOS
18-
- Amazon Linux 2 or Linux 2023
19-
20-
### Install Plane
21-
22-
1. `ssh` into your machine as the root user (or user with sudo access) per the norms of your hosting provider.
23-
2. Run the command below:
24-
```
25-
curl -fsSL https://prime.plane.so/install/ | sh -
26-
```
27-
3. Follow the instructions on the terminal. Hit `Enter` or `Return` to continue.
28-
4. Enter the domain name where you will access the Plane app in the format `domain.tld` or `subdomain.domain.tld`. If you are using a paid plan, the domain linked to the license can’t be changed later.
29-
5. Choose one of the options below:
30-
- **Express**: Plane installs with the default configurations.
31-
- **Advanced**: You can customize the database, Redis, storage and other settings.
32-
6. The installation will take a few minutes to complete and you will see the message **Plane has successfully installed**. You can access the Plane application on the domain you provided during the installation.
33-
7. If you want to activate the license for a paid plan, see [Activate instance](/self-hosting/manage-plans/prime-client).
34-
</Tab>
35-
36-
<Tab title="COMMUNITY">
37-
### Prerequisites
38-
39-
- Docker installed and running. Choose one of the following options:
40-
- **Option 1**: Create an EC2 machine on AWS. It must of minimum **t3.medium/t3a.medium**. Run the below command to install docker engine.
41-
```bash
42-
curl -fsSL https://get.docker.com | sh -
43-
```
44-
- **Option 2**: Install [Docker Desktop](https://www.docker.com/products/docker-desktop/).
45-
- OS with bash scripting enabled (Ubuntu, Linux AMI, macos). Windows systems need to have [gitbash](https://git-scm.com/download/win).
46-
- User context used must have access to docker services. In most cases, use `sudo su` to switch as root user.
47-
- Use the terminal (or gitbash) window to run all the future steps.
48-
49-
### Install Plane
7+
## Install Plane
8+
To install Plane, follow the steps below:
9+
10+
### Prerequisites
11+
12+
- A virtual or on-prem machine with atleast 2 vCPUs and 4 GB RAM
13+
- `x64` AKA `AMD 64` or `AArch 64` AKA `ARM 64` CPUs
14+
- Supported operating systems:
15+
- Ubuntu
16+
- Debian
17+
- CentOS
18+
- Amazon Linux 2 or Linux 2023
19+
20+
### Procedure
21+
22+
1. `ssh` into your machine as the root user (or user with sudo access) per the norms of your hosting provider.
23+
2. Run the command below:
24+
```
25+
curl -fsSL https://prime.plane.so/install/ | sh -
26+
```
27+
3. Follow the instructions on the terminal. Hit `Enter` or `Return` to continue.
28+
4. Enter the domain name where you will access the Plane app in the format `domain.tld` or `subdomain.domain.tld`. If you are using a paid plan, the domain linked to the license can’t be changed later.
29+
5. Choose one of the options below:
30+
- **Express**: Plane installs with the default configurations.
31+
- **Advanced**: You can customize the database, Redis, storage and other settings.
32+
6. The installation will take a few minutes to complete and you will see the message **Plane has successfully installed**. You can access the Plane application on the domain you provided during the installation.
33+
7. If you want to activate the license for a paid plan, see [Activate License](/self-hosting/prime-client).
34+
35+
<AccordionGroup>
36+
<Accordion title="Install Community edition">
37+
38+
The Enterprise edition comes with a **free plan** and the flexibility to upgrade to a paid plan at any point. If you still want to install the Community edittion, follow the steps below:
39+
40+
### Prerequisites
41+
42+
- Docker installed and running. Choose one of the following options:
43+
- **Option 1**: Create an EC2 machine on AWS. It must of minimum **t3.medium/t3a.medium**. Run the below command to install docker engine.
44+
```bash
45+
curl -fsSL https://get.docker.com | sh -
46+
```
47+
- **Option 2**: Install [Docker Desktop](https://www.docker.com/products/docker-desktop/).
48+
- OS with bash scripting enabled (Ubuntu, Linux AMI, macos). Windows systems need to have [gitbash](https://git-scm.com/download/win).
49+
- User context used must have access to docker services. In most cases, use `sudo su` to switch as root user.
50+
- Use the terminal (or gitbash) window to run all the future steps.
51+
52+
### Procedure
5053
1. Create a folder named `plane-selfhost` on your machine for deployment and data storage.
51-
54+
5255
```bash
5356
mkdir plane-selfhost
5457
```
@@ -60,16 +63,16 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using D
6063
```bash
6164
curl -fsSL -o setup.sh https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh
6265
```
63-
66+
6467
<Note>
6568
If you want to download the latest preview release, run the following commands:
66-
```bash
67-
export RELEASE=preview
68-
```
69-
```bash
70-
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/$RELEASE/deploy/selfhost/install.sh | sed 's@BRANCH=master@BRANCH='"$RELEASE"'@' > setup.sh
71-
```
72-
</Note>
69+
```bash
70+
export RELEASE=preview
71+
```
72+
```bash
73+
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/$RELEASE/deploy/selfhost/install.sh | sed 's@BRANCH=master@BRANCH='"$RELEASE"'@' > setup.sh
74+
```
75+
</Note>
7376
4. Make the file executable.
7477
```bash
7578
chmod +x setup.sh
@@ -78,7 +81,7 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using D
7881
```bash
7982
./setup.sh
8083
```
81-
This will prompt you with the below options.
84+
This will prompt you with the below options.
8285
```list
8386
Select a Action you want to perform:
8487
1) Install (arm64)
@@ -94,50 +97,41 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using D
9497
6. Enter `1` as input.
9598
This will create a folder `plane-app` or `plane-app-preview` (in case of preview deployment) and will download the `docker-compose.yaml` and `.env` files.
9699
7. Enter `8` to exit.
97-
98100
8. Set up the environment variables. You can use any text editor to edit this file. Below are the most importants keys you must refer to:
99-
100101
- `NGINX_PORT`: This is set to `80` by default. Make sure the port you choose to use is not preoccupied. For example, `NGINX_PORT=8080`
101-
102102
- `WEB_URL`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with NGINX\_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`.
103-
104103
- `CORS_ALLOWED_ORIGINS`: This is set to `http://localhost` by default. Change this to the FQDN you plan to use along with NGINX\_PORT. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`.
105-
106104
9. Run the following command to continue with the setup.
107105
```bash
108106
./setup.sh
109107
```
110108
10. Enter `2` as input to to start the services.
111-
112-
You will something like this:
109+
You will something like this:
113110
![Downloading docker images](/images/docker-compose/download-docker.png)
114-
115-
Be patient as it might take some time based on your download speed and system configuration. If all goes well, you must see something like this:
116-
111+
Be patient as it might take some time based on your download speed and system configuration. If all goes well, you must see something like this:
117112
![Downloading completed](/images/docker-compose/download-complete.png)
118-
119-
This is the confirmation that all images were downloaded and the services are up and running.
113+
This is the confirmation that all images were downloaded and the services are up and running.
120114

121115
You have successfully self-hosted the `Plane` instance. Access the application by going to IP or domain you have configured it on. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`.
122116

123-
124117
### Stop server
125118

126-
In case you want to make changes to `.env` variables, we recommend that you stop the services before doing that.
119+
In case you want to make changes to `.env` variables, we recommend that you stop the services before doing that.
120+
121+
Run the `./setup.sh` command. Enter `3` to stop the services.
127122

128-
Run the `./setup.sh` command. Enter `3` to stop the services.
123+
If all goes well, you will see something like this:
129124

130-
If all goes well, you will see something like this:
125+
![Stop Services](/images/docker-compose/stopped-docker.png)
131126

132-
![Stop Services](/images/docker-compose/stopped-docker.png)
127+
### Restart server
133128

134-
### Restart server
129+
In case you want to make changes to `.env` variables without stopping the server or noticed some abnormalities in services, you can restart the services.
135130

136-
In case you want to make changes to `.env` variables without stopping the server or noticed some abnormalities in services, you can restart the services.
131+
Run the `./setup.sh` command. Enter `4` to restart the services.
137132

138-
Run the `./setup.sh` command. Enter `4` to restart the services.
133+
If all goes well, you will see something like this:
134+
![Restart Services](/images/docker-compose/restart-docker.png)
139135

140-
If all goes well, you will see something like this:
141-
![Restart Services](/images/docker-compose/restart-docker.png)
142-
</Tab>
143-
</Tabs>
136+
</Accordion>
137+
</AccordionGroup>

0 commit comments

Comments
 (0)