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/coolify.mdx
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,5 +43,6 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using C
43
43
-`AMQP_URL` – Connection string for your external RabbitMQ server.
44
44
45
45
8. Deploy to launch your Plane instance.
46
+
Once the deployment is complete, your Plane instance should be accessible on the configured domain.
46
47
47
-
Once the deployment is complete, your Plane instance should be accessible on the configured domain.
48
+
9. If you've purchased a paid plan, [activate your license key](https://docs.plane.so/workspaces-and-users/manage-licenses#activate-license) to unlock premium features.
2. Once it's running, you can access the Plane application on the domain you provided during the deployment.
97
+
3. Once it's running, you can access the Plane application on the domain you provided during the deployment.
98
+
99
+
4. If you've purchased a paid plan, [activate your license key](https://docs.plane.so/workspaces-and-users/manage-licenses#activate-license) to unlock premium features.
Copy file name to clipboardExpand all lines: self-hosting/methods/docker-compose.mdx
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Docker
2
+
title: Docker Compose
3
3
---
4
4
5
5
This guide shows you the steps to deploy a self-hosted instance of Plane using Docker.
@@ -40,10 +40,8 @@ Ensure you're using the **latest version of Docker Compose**. Check your Docker
40
40
When self-hosting Plane for production use, it is strongly recommended to configure [external database and storage](/self-hosting/govern/database-and-storage). This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption.
41
41
</Warning>
42
42
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.
43
-
44
-
<Tip>
45
-
If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan).
46
-
</Tip>
43
+
7. If you've purchased a paid plan, [activate your license key](https://docs.plane.so/workspaces-and-users/manage-licenses#activate-license) to unlock premium features.
44
+
47
45
48
46
<Accordiontitle="Install Community Edition ">
49
47
The Commercial 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 edition, follow the steps below:
That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain.
59
+
That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain.
60
+
61
+
5. If you've purchased a paid plan, [activate your license key](https://docs.plane.so/workspaces-and-users/manage-licenses#activate-license) to unlock premium features.
Copy file name to clipboardExpand all lines: self-hosting/methods/kubernetes.mdx
+35-37Lines changed: 35 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Ensure you use use the latest Helm chart version.
26
26
1. Open terminal or any other command-line app that has access to Kubernetes tools on your local system.
27
27
2. Set the following environment variables:
28
28
```bash
29
-
PLANE_VERSION=v1.15.0
29
+
PLANE_VERSION=v1.16.0
30
30
```
31
31
```bash
32
32
DOMAIN_NAME=<subdomain.domain.tld or domain.tld>
@@ -44,29 +44,29 @@ Ensure you use use the latest Helm chart version.
44
44
45
45
4. Use one of the following ways to deploy Plane:
46
46
-**Quick setup**:
47
-
This is the fastest way to deploy Plane with the default settings. This will create stateful deployments for Postgres, Redis/Valkey, and Minio with a persistent volume claim using the `longhorn` storage class. This also sets up the Ingress routes for you using `nginx` ingress class. To customize these settings, see the [Custom ingress routes](#custom-ingress-routes).
47
+
This is the fastest way to deploy Plane with the default settings. This will create stateful deployments for Postgres, Redis/Valkey, and Minio with a persistent volume claim using the `longhorn` storage class. This also sets up the Ingress routes for you using `nginx` ingress class. To customize these settings, see the [Custom ingress routes](#custom-ingress-routes).
This is the minimum required to set up Plane Commercial edition. You can change the default namespace from `plane`, the default app name from `plane-app`, the default storage class from `longhorn`, and the default ingress class from `nginx` to whatever you would like to.<br/> <br/>
68
-
You can also pass other settings referring to the **Configuration Settings** toggle section below.
69
-
</Note>
66
+
<Note>
67
+
This is the minimum required to set up Plane Commercial edition. You can change the default namespace from `plane`, the default app name from `plane-app`, the default storage class from `longhorn`, and the default ingress class from `nginx` to whatever you would like to.<br/> <br/>
68
+
You can also pass other settings referring to the **Configuration Settings** toggle section below.
69
+
</Note>
70
70
71
71
-**Advanced setup**:
72
72
<Warning>
@@ -77,20 +77,20 @@ Ensure you use use the latest Helm chart version.
77
77
78
78
1. Run the script below to download the `values.yaml` file and and edit using any editor like Vim or Nano.
79
79
80
-
```bash
81
-
helm show values plane/plane-enterprise > values.yaml
82
-
vi values.yaml
83
-
```
80
+
```bash
81
+
helm show values plane/plane-enterprise > values.yaml
82
+
vi values.yaml
83
+
```
84
84
85
-
Make sure you set the required environment variables listed below:
86
-
-`planeVersion: v1.15.0`
87
-
-`license.licenseDomain: <The domain you have specified to host Plane>`
88
-
-`license.licenseServer: https://prime.plane.so`
89
-
-`ingress.enabled: <true | false>`
90
-
-`ingress.ingressClass: <nginx or any other ingress class configured in your cluster>`
91
-
-`env.storageClass: <longhorn or any other storage class configured in your cluster>`
85
+
Make sure you set the required environment variables listed below:
86
+
-`planeVersion: v1.16.0`
87
+
-`license.licenseDomain: <The domain you have specified to host Plane>`
88
+
-`license.licenseServer: https://prime.plane.so`
89
+
-`ingress.enabled: <true | false>`
90
+
-`ingress.ingressClass: <nginx or any other ingress class configured in your cluster>`
91
+
-`env.storageClass: <longhorn or any other storage class configured in your cluster>`
92
92
93
-
See the **Configuration settings** toggle section for more details.
93
+
See the **Configuration settings** toggle section for more details.
94
94
95
95
2. After saving the `values.yaml` file, run the following command to deploy Plane:
96
96
@@ -103,17 +103,15 @@ Ensure you use use the latest Helm chart version.
103
103
--wait \
104
104
--wait-for-jobs
105
105
```
106
-
<Tip>
107
-
If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan).
108
-
</Tip>
106
+
5. If you've purchased a paid plan, [activate your license key](https://docs.plane.so/workspaces-and-users/manage-licenses#activate-license) to unlock premium features.
109
107
110
108
### Configuration settings
111
109
112
110
#### License
113
111
114
112
| Setting | Default | Required | Description |
115
113
|---|:---:|:---:|---|
116
-
| planeVersion | v1.15.0 | Yes | Specifies the version of Plane to be deployed. Copy this from `prime.plane.so.`|
114
+
| planeVersion | v1.16.0 | Yes | Specifies the version of Plane to be deployed. Copy this from `prime.plane.so.`|
117
115
| license.licenseDomain | 'plane.example.com' | Yes | The fully-qualified domain name (FQDN) in the format `sudomain.domain.tld` or `domain.tld` that the license is bound to. It is also attached to your `ingress` host to access Plane. |
The startup sequence is important: network first, then dependencies, followed by backend services, and finally frontend services.
98
+
The startup sequence is important: network first, then dependencies, followed by backend services, and finally frontend services.
99
+
100
+
6. If you've purchased a paid plan, [activate your license key](https://docs.plane.so/workspaces-and-users/manage-licenses#activate-license) to unlock premium features.
Copy file name to clipboardExpand all lines: self-hosting/methods/portainer.mdx
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,5 +52,6 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using P
52
52
-`AMQP_URL` – Connection string for your external RabbitMQ server.
53
53
54
54
7. Click **Deploy the stack**.
55
+
That's it! Once the deployment is complete, Plane should be up and running on your configured domain.
55
56
56
-
That's it! Once the deployment is complete, Plane should be up and running on your configured domain.
57
+
8. If you've purchased a paid plan, [activate your license key](https://docs.plane.so/workspaces-and-users/manage-licenses#activate-license) to unlock premium features.
0 commit comments