Skip to content

Commit a88140c

Browse files
plane-botplane-bot
authored
Deploy Plane on Swarm, Portainer and Coolify #81 
2 parents 233d4f4 + 86bcd1a commit a88140c

File tree

4 files changed

+166
-1
lines changed

4 files changed

+166
-1
lines changed

‎mint.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,10 @@
6868
"group": "Install",
6969
"pages": [
7070
"self-hosting/methods/docker-compose",
71-
"self-hosting/methods/kubernetes"
71+
"self-hosting/methods/docker-swarm",
72+
"self-hosting/methods/kubernetes",
73+
"self-hosting/methods/coolify",
74+
"self-hosting/methods/portainer"
7275
]
7376
},
7477
{

‎self-hosting/methods/coolify.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Deploy Plane with Coolify • Commercial Edition
3+
sidebarTitle: Coolify
4+
---
5+
6+
This guide shows you the steps to deploy a self-hosted instance of Plane using Coolify.
7+
8+
## Install Plane
9+
10+
### Prerequisites
11+
12+
- Before you get started, make sure you have a Coolify environment set up and ready to go.
13+
- Your setup should support either amd64 or arm64 architectures.
14+
15+
### Procedure
16+
17+
1. **Download the required depoyment files**
18+
- `coolify-compose.yml` – Defines Plane's services and dependencies.
19+
20+
```bash
21+
curl -fsSL https://prime.plane.so/releases/<plane-version>/coolify-compose.yml -o coolify-compose.yml
22+
```
23+
24+
<Warning>
25+
The `<plane-version>` value should be v1.8.2 or higher.
26+
</Warning>
27+
28+
2. Create a new project in Coolify.
29+
30+
3. Add a new resource.
31+
32+
4. Select **Docker Compose Empty** as the deployment method.
33+
34+
5. Copy and paste the contents of the `coolify-compose.yml` file into the editor.
35+
36+
6. Configure external DB, Redis, RabbitMQ and any other required environment variables in the UI.
37+
<Warning>
38+
When self-hosting Plane for production use, it is strongly recommended to configure external 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.
39+
</Warning>
40+
41+
- `DATABASE_URL` – Connection string for your external database.
42+
- `REDIS_URL` – Connection string for your external Redis instance.
43+
- `AMQP_URL` – Connection string for your external RabbitMQ server.
44+
45+
8. Deploy to launch your Plane instance.
46+
47+
Once the deployment is complete, your Plane instance should be accessible on the configured domain.

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

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Deploy Plane with Docker Swarm • Commercial Edition
3+
sidebarTitle: Docker Swarm
4+
---
5+
6+
This guide shows you the steps to deploy a self-hosted instance of the Plane Commercial Edition using Docker Swarm.
7+
8+
## Install Plane
9+
10+
### Prerequisites
11+
- Before you get started, make sure you have a Docker Swarm environment set up and ready to go.
12+
- Your setup should support either amd64 or arm64 architectures.
13+
14+
### Procedure
15+
16+
1. **Download the required depoyment files**
17+
- `docker-compose.yml` – Defines Plane's services and dependencies.
18+
```bash
19+
curl -fsSL https://prime.plane.so/releases/<plane-version>/docker-compose.yml -o docker-compose.yml
20+
```
21+
- `variables.env` – Stores environment variables for your deployment.
22+
```bash
23+
curl -fsSL https://prime.plane.so/releases/<plane-version>/variables.env -o plane.env
24+
```
25+
<Warning>
26+
The `<plane-version>` value should be v1.8.2 or higher.
27+
</Warning>
28+
29+
2. **Configure environment variables**
30+
Before deploying, edit the `variables.env` file in your preferred text editor and update the following values:
31+
32+
- `DOMAIN_NAME` – (required) Your application's domain name.
33+
- `SITE_ADDRESS` – (required) The full domain name (FQDN) of your instance.
34+
- `MACHINE_SIGNATURE` – (required) A unique identifier for your machine. You can generate this by running below code in terminal:
35+
```sh
36+
sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env
37+
```
38+
- `CERT_EMAIL` – (optional) Email address for SSL certificate generation (only needed if you're setting up HTTPS).
39+
40+
3. **Configure external DB, Redis, and RabbitMQ**
41+
<Warning>
42+
When self-hosting Plane for production use, it is strongly recommended to configure external 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.
43+
</Warning>
44+
- `DATABASE_URL` – Connection string for your external database.
45+
- `REDIS_URL` – Connection string for your external Redis instance.
46+
- `AMQP_URL` – Connection string for your external RabbitMQ server.
47+
48+
49+
3. **Load the environment variables**
50+
```bash
51+
set -o allexport; source <path-to variables.env>; set +o allexport;
52+
```
53+
54+
4. **Deploy the stack**
55+
```bash
56+
docker stack deploy -c <path-to docker-compose.yml> plane
57+
```
58+
59+
That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain.

‎self-hosting/methods/portainer.mdx‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Deploy Plane with Portainer • Commercial Edition
3+
sidebarTitle: Portainer
4+
---
5+
6+
This guide shows you the steps to deploy a self-hosted instance of Plane using Portainer.
7+
8+
## Install Plane
9+
10+
### Prerequisites
11+
- Before you get started, make sure you have a Portainer environment set up and ready to go.
12+
- Your setup should support either amd64 or arm64 architectures.
13+
14+
### Procedure
15+
16+
1. **Download the required depoyment files**
17+
- `docker-compose.yml` – Defines Plane's services and dependencies.
18+
```bash
19+
curl -fsSL https://prime.plane.so/releases/<plane-version>/docker-compose.yml -o docker-compose.yml
20+
```
21+
- `variables.env` – Stores environment variables for your deployment.
22+
```bash
23+
curl -fsSL https://prime.plane.so/releases/<plane-version>/variables.env -o plane.env
24+
```
25+
<Warning>
26+
The `<plane-version>` value should be v1.8.2 or higher.
27+
</Warning>
28+
29+
2. Click **+ Add stack** on Portainer.
30+
31+
3. Copy and paste the contents of `docker-compose.yml` into the editor.
32+
33+
4. Load environment variables from the `variables.env` file.
34+
35+
5. **Configure environment variables**
36+
Before deploying, edit the following variables:
37+
38+
- `DOMAIN_NAME` – (required) Your application's domain name.
39+
- `SITE_ADDRESS` – (required) The full domain name (FQDN) of your instance.
40+
- `MACHINE_SIGNATURE` – (required) A unique identifier for your machine. You can generate this by running below code in terminal:
41+
```sh
42+
sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env
43+
```
44+
- `CERT_EMAIL` – (optional) Email address for SSL certificate generation (only needed if you're setting up HTTPS).
45+
46+
6. **Configure external DB, Redis, and RabbitMQ**
47+
<Warning>
48+
When self-hosting Plane for production use, it is strongly recommended to configure external 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.
49+
</Warning>
50+
- `DATABASE_URL` – Connection string for your external database.
51+
- `REDIS_URL` – Connection string for your external Redis instance.
52+
- `AMQP_URL` – Connection string for your external RabbitMQ server.
53+
54+
7. Click **Deploy the stack**.
55+
56+
That's it! Once the deployment is complete, Plane should be up and running on your configured domain.

0 commit comments

Comments
 (0)