From aca30f58cbe2a55c6160de258990e3ce77de01e1 Mon Sep 17 00:00:00 2001 From: akshat5302 Date: Thu, 6 Nov 2025 14:58:59 +0530 Subject: [PATCH 1/2] Update Kubernetes configuration to version v1.16.0 --- self-hosting/methods/kubernetes.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/self-hosting/methods/kubernetes.mdx b/self-hosting/methods/kubernetes.mdx index 79ae477..fc2226f 100644 --- a/self-hosting/methods/kubernetes.mdx +++ b/self-hosting/methods/kubernetes.mdx @@ -26,7 +26,7 @@ Ensure you use use the latest Helm chart version. 1. Open terminal or any other command-line app that has access to Kubernetes tools on your local system. 2. Set the following environment variables: ```bash - PLANE_VERSION=v1.15.0 + PLANE_VERSION=v1.16.0 ``` ```bash DOMAIN_NAME= @@ -83,7 +83,7 @@ Ensure you use use the latest Helm chart version. ``` Make sure you set the required environment variables listed below: - - `planeVersion: v1.15.0` + - `planeVersion: v1.16.0` - `license.licenseDomain: ` - `license.licenseServer: https://prime.plane.so` - `ingress.enabled: ` @@ -113,7 +113,7 @@ If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so | Setting | Default | Required | Description | |---|:---:|:---:|---| - | planeVersion | v1.15.0 | Yes | Specifies the version of Plane to be deployed. Copy this from `prime.plane.so.` | + | planeVersion | v1.16.0 | Yes | Specifies the version of Plane to be deployed. Copy this from `prime.plane.so.` | | 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. | #### Airgapped settings From e7b422a6fd875cdcd63e3825fe2a8a6c2e2bd24e Mon Sep 17 00:00:00 2001 From: danciaclara Date: Mon, 10 Nov 2025 20:50:04 +0530 Subject: [PATCH 2/2] Added activate license stepped in all deployments --- mint.json | 24 ++++++--- self-hosting/methods/coolify.mdx | 3 +- self-hosting/methods/docker-aio.mdx | 4 +- self-hosting/methods/docker-compose.mdx | 8 ++- self-hosting/methods/docker-swarm.mdx | 4 +- self-hosting/methods/kubernetes.mdx | 68 ++++++++++++------------ self-hosting/methods/podman-quadlets.mdx | 4 +- self-hosting/methods/portainer.mdx | 3 +- 8 files changed, 66 insertions(+), 52 deletions(-) diff --git a/mint.json b/mint.json index 72bd3f5..bd49cd1 100644 --- a/mint.json +++ b/mint.json @@ -51,7 +51,7 @@ "url": "api-reference" }, { - "name": "Dev Tools", + "name": "Build and extend", "url": "dev-tools" } ], @@ -67,12 +67,16 @@ { "group": "Install", "pages": [ - "self-hosting/methods/docker-compose", - "self-hosting/methods/docker-aio", - "self-hosting/methods/docker-swarm", + { + "group": "Docker", + "pages": [ + "self-hosting/methods/docker-compose", + "self-hosting/methods/docker-aio", + "self-hosting/methods/docker-swarm" + ] + }, "self-hosting/methods/kubernetes", - "self-hosting/methods/coolify", - "self-hosting/methods/portainer", + "self-hosting/methods/podman-quadlets", { "group": "Airgapped Edition", "pages": [ @@ -80,7 +84,13 @@ "self-hosting/methods/airgapped-edition-kubernetes" ] }, - "self-hosting/methods/podman-quadlets" + { + "group": "Managed platforms", + "pages": [ + "self-hosting/methods/coolify", + "self-hosting/methods/portainer" + ] + } ] }, { diff --git a/self-hosting/methods/coolify.mdx b/self-hosting/methods/coolify.mdx index 6dd3d4f..661dbed 100644 --- a/self-hosting/methods/coolify.mdx +++ b/self-hosting/methods/coolify.mdx @@ -43,5 +43,6 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using C - `AMQP_URL` – Connection string for your external RabbitMQ server. 8. Deploy to launch your Plane instance. + Once the deployment is complete, your Plane instance should be accessible on the configured domain. -Once the deployment is complete, your Plane instance should be accessible on the configured domain. \ No newline at end of file +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. \ No newline at end of file diff --git a/self-hosting/methods/docker-aio.mdx b/self-hosting/methods/docker-aio.mdx index 1e05478..a61434b 100644 --- a/self-hosting/methods/docker-aio.mdx +++ b/self-hosting/methods/docker-aio.mdx @@ -94,7 +94,9 @@ The following ports are exposed: artifacts.plane.so/makeplane/plane-aio-commercial:stable ``` -2. Once it's running, you can access the Plane application on the domain you provided during the deployment. +3. Once it's running, you can access the Plane application on the domain you provided during the deployment. + +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. ## Volume mounts diff --git a/self-hosting/methods/docker-compose.mdx b/self-hosting/methods/docker-compose.mdx index fa40c29..f1b9e38 100644 --- a/self-hosting/methods/docker-compose.mdx +++ b/self-hosting/methods/docker-compose.mdx @@ -1,5 +1,5 @@ --- -title: Docker +title: Docker Compose --- 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 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. 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. - - -If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan). - + 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. + 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: diff --git a/self-hosting/methods/docker-swarm.mdx b/self-hosting/methods/docker-swarm.mdx index 349d624..43710e3 100644 --- a/self-hosting/methods/docker-swarm.mdx +++ b/self-hosting/methods/docker-swarm.mdx @@ -56,4 +56,6 @@ This guide shows you the steps to deploy a self-hosted instance of the Plane Com docker stack deploy -c plane ``` -That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain. \ No newline at end of file + That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain. + +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. \ No newline at end of file diff --git a/self-hosting/methods/kubernetes.mdx b/self-hosting/methods/kubernetes.mdx index fc2226f..3ee9d54 100644 --- a/self-hosting/methods/kubernetes.mdx +++ b/self-hosting/methods/kubernetes.mdx @@ -44,29 +44,29 @@ Ensure you use use the latest Helm chart version. 4. Use one of the following ways to deploy Plane: - **Quick setup**: - 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 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). - Run the following command to deploy Plane: + Run the following command to deploy Plane: - ```bash - helm install plane-app plane/plane-enterprise \ - --create-namespace \ - --namespace plane \ - --set license.licenseDomain=${DOMAIN_NAME} \ - --set license.licenseServer=https://prime.plane.so \ - --set planeVersion=${PLANE_VERSION} \ - --set ingress.enabled=true \ - --set ingress.ingressClass=nginx \ - --set env.storageClass=longhorn \ - --timeout 10m \ - --wait \ - --wait-for-jobs - ``` + ```bash + helm install plane-app plane/plane-enterprise \ + --create-namespace \ + --namespace plane \ + --set license.licenseDomain=${DOMAIN_NAME} \ + --set license.licenseServer=https://prime.plane.so \ + --set planeVersion=${PLANE_VERSION} \ + --set ingress.enabled=true \ + --set ingress.ingressClass=nginx \ + --set env.storageClass=longhorn \ + --timeout 10m \ + --wait \ + --wait-for-jobs + ``` - - 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.

- You can also pass other settings referring to the **Configuration Settings** toggle section below. - + + 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.

+ You can also pass other settings referring to the **Configuration Settings** toggle section below. + - **Advanced setup**: @@ -77,20 +77,20 @@ Ensure you use use the latest Helm chart version. 1. Run the script below to download the `values.yaml` file and and edit using any editor like Vim or Nano. - ```bash - helm show values plane/plane-enterprise > values.yaml - vi values.yaml - ``` + ```bash + helm show values plane/plane-enterprise > values.yaml + vi values.yaml + ``` - Make sure you set the required environment variables listed below: - - `planeVersion: v1.16.0` - - `license.licenseDomain: ` - - `license.licenseServer: https://prime.plane.so` - - `ingress.enabled: ` - - `ingress.ingressClass: ` - - `env.storageClass: ` + Make sure you set the required environment variables listed below: + - `planeVersion: v1.16.0` + - `license.licenseDomain: ` + - `license.licenseServer: https://prime.plane.so` + - `ingress.enabled: ` + - `ingress.ingressClass: ` + - `env.storageClass: ` - See the **Configuration settings** toggle section for more details. + See the **Configuration settings** toggle section for more details. 2. After saving the `values.yaml` file, run the following command to deploy Plane: @@ -103,9 +103,7 @@ Ensure you use use the latest Helm chart version. --wait \ --wait-for-jobs ``` - -If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan). - + 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. ### Configuration settings diff --git a/self-hosting/methods/podman-quadlets.mdx b/self-hosting/methods/podman-quadlets.mdx index 32a4366..44d6ce7 100644 --- a/self-hosting/methods/podman-quadlets.mdx +++ b/self-hosting/methods/podman-quadlets.mdx @@ -95,7 +95,9 @@ Note that you should run these commands without `sudo`. systemctl --user start {web,space,admin,live,proxy}.service ``` -The startup sequence is important: network first, then dependencies, followed by backend services, and finally frontend services. + The startup sequence is important: network first, then dependencies, followed by backend services, and finally frontend services. + +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. ### Verify service status Check that all services are running correctly: diff --git a/self-hosting/methods/portainer.mdx b/self-hosting/methods/portainer.mdx index ee82971..fa72fd3 100644 --- a/self-hosting/methods/portainer.mdx +++ b/self-hosting/methods/portainer.mdx @@ -52,5 +52,6 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using P - `AMQP_URL` – Connection string for your external RabbitMQ server. 7. Click **Deploy the stack**. + That's it! Once the deployment is complete, Plane should be up and running on your configured domain. -That's it! Once the deployment is complete, Plane should be up and running on your configured domain. \ No newline at end of file +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. \ No newline at end of file