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/methods/docker-compose.mdx
+10-15Lines changed: 10 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,8 @@ title: Docker
4
4
5
5
This guide shows you the steps to deploy a self-hosted instance of Plane using Docker.
6
6
7
-
## Install Plane
8
-
To install Plane, follow the steps below:
7
+
## Enterprise edition
8
+
To install the Enterprise edition (Plane One and Plane Pro), follow the steps below:
9
9
10
10
### Prerequisites
11
11
@@ -17,7 +17,7 @@ To install Plane, follow the steps below:
17
17
- CentOS
18
18
- Amazon Linux 2 or Linux 2023
19
19
20
-
### Procedure
20
+
### Install Plane
21
21
22
22
1.`ssh` into your machine as the root user (or user with sudo access) per the norms of your hosting provider.
23
23
2. Run the command below:
@@ -30,12 +30,10 @@ To install Plane, follow the steps below:
30
30
-**Express**: Plane installs with the default configurations.
31
31
-**Advanced**: You can customize the database, Redis, storage and other settings.
32
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).
33
+
7. If you want to activate the license for a paid plan, see [Activate License](/self-hosting/activate-license).
34
34
35
-
<AccordionGroup>
36
-
<Accordiontitle="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:
35
+
## Community edition
36
+
To install the Community edition, follow the steps below:
39
37
40
38
### Prerequisites
41
39
@@ -49,7 +47,7 @@ To install Plane, follow the steps below:
49
47
- User context used must have access to docker services. In most cases, use `sudo su` to switch as root user.
50
48
- Use the terminal (or gitbash) window to run all the future steps.
51
49
52
-
### Procedure
50
+
### Install Plane
53
51
1. Create a folder named `plane-selfhost` on your machine for deployment and data storage.
54
52
55
53
```bash
@@ -114,7 +112,7 @@ To install Plane, follow the steps below:
114
112
115
113
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`.
116
114
117
-
### Stop server
115
+
####Stop server
118
116
119
117
In case you want to make changes to `.env` variables, we recommend that you stop the services before doing that.
120
118
@@ -124,14 +122,11 @@ To install Plane, follow the steps below:
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.
130
128
131
129
Run the `./setup.sh` command. Enter `4` to restart the services.
132
130
133
131
If all goes well, you will see something like this:
Copy file name to clipboardExpand all lines: self-hosting/methods/kubernetes.mdx
+27-42Lines changed: 27 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,17 +4,15 @@ title: Kubernetes
4
4
5
5
This guide shows you the steps to deploy a self-hosted instance of Plane using Kubernetes.
6
6
7
-
## Install Plane
7
+
## Enterprise edition
8
8
To install Plane, follow the steps below:
9
9
10
-
The Enterprise edition comes with a **free plan** and the flexibility to upgrade to a paid plan at any point.
11
-
12
-
### Prerequisites
10
+
### Prerequisites
13
11
14
12
- A working Kubernetes cluster
15
13
-`kubectl` and `helm` on the client system that you will use to install our Helm charts
16
14
17
-
### Procedure
15
+
### Install Plane
18
16
19
17
1. Open terminal or any other command-line app that has access to Kubernetes tools on your local system.
20
18
2. Set the following environment variables:
@@ -90,9 +88,10 @@ To install Plane, follow the steps below:
90
88
--wait \
91
89
--wait-for-jobs
92
90
```
93
-
5. If you want to activate the license for a paid plan, see [Activate License](/self-hosting/prime-client).
91
+
5. If you want to activate the license for a paid plan, see [Activate License](/self-hosting/activate-license).
94
92
95
-
### Configuration settings
93
+
<AccordionGroup>
94
+
<Accordiontitle="Configuration settings">
96
95
97
96
#### Docker registry
98
97
@@ -244,31 +243,16 @@ To install Plane, follow the steps below:
244
243
| env.storageClass | longhorn || Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
245
244
| env.secret_key | 60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5 | Yes | This must be a random string which is used for hashing/encrypting the sensitive data within the application. Once set, changing this might impact the already hashed/encrypted data|
246
245
247
-
### Custom Ingress Routes
248
-
249
-
If you are planning to use 3rd party ingress providers, here is the available route configuration
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:
265
-
266
-
### Prerequisites
249
+
## Community edition
250
+
### Prerequisites
267
251
268
252
- A working Kubernetes cluster
269
253
- `kubectl` and `helm` on the client system that you will use to install our Helm charts
270
254
271
-
### Procedure
255
+
### Install Plane
272
256
273
257
1. Open Terminal or any other command-line app that has access to Kubernetes tools on your local system.
274
258
1. Add the Helm Repo
@@ -331,8 +315,8 @@ To install Plane, follow the steps below:
331
315
--wait-for-jobs
332
316
```
333
317
334
-
### Configuration settings
335
-
---
318
+
<AccordionGroup>
319
+
<Accordiontitle="Configuration settings">
336
320
337
321
#### Plane Version
338
322
@@ -461,19 +445,20 @@ To install Plane, follow the steps below:
461
445
|---|:---:|:---:|---|
462
446
| env.secret_key | 60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5 | Yes | This must be a random string that is used for hashing/encrypting the sensitive data within the application. Once set, changing this might impact the already hashed/encrypted data|
463
447
464
-
### Custom Ingress Routes
448
+
</Accordion>
449
+
</AccordionGroup>
450
+
465
451
466
-
If you are planning to use 3rd party ingress providers, here is the available route configuration
Copy file name to clipboardExpand all lines: self-hosting/upgrade-from-community.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
@@ -77,4 +77,4 @@ The Enterprise edition comes with a **free plan** and the flexibility to upgrade
77
77
- **Express**: Plane installs with the default configurations.
78
78
- **Advanced**: You can customize the database, Redis, storage and other settings.
79
79
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.
80
-
7. If you want to activate the license for a paid plan, see [Activate License](/self-hosting/prime-client).
80
+
7. If you want to activate the license for a paid plan, see [Activate License](/self-hosting/activate-license).
0 commit comments