Skip to content

Commit 7e4947b

Browse files
committed
Deploy Plane on Portainer
1 parent c93a87b commit 7e4947b

File tree

2 files changed

+55
-1
lines changed

2 files changed

+55
-1
lines changed

mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@
6868
"group": "Install",
6969
"pages": [
7070
"self-hosting/methods/docker-compose",
71-
"self-hosting/methods/kubernetes"
71+
"self-hosting/methods/kubernetes",
72+
"self-hosting/methods/portainer"
7273
]
7374
},
7475
{

self-hosting/methods/portainer.mdx

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Portainer
3+
---
4+
5+
This guide shows you the steps to deploy a self-hosted instance of Plane using Portainer.
6+
7+
## Install Plane
8+
9+
### Prerequisites
10+
11+
- A virtual or on-prem machine with atleast 2 vCPUs and 4 GB RAM
12+
- `x64` AKA `AMD 64` or `AArch 64` AKA `ARM 64` CPUs
13+
- Supported operating systems:
14+
- Ubuntu
15+
- Debian
16+
- CentOS
17+
- Amazon Linux 2 or Linux 2023
18+
19+
### Procedure
20+
21+
1. **Download the required files**
22+
You'll need two essential files to get started:
23+
24+
- [docker-compose.yml](https://prime.plane.so/deployment/assets/docker-compose.yml) – Defines the services and dependencies required for Plane.
25+
- [variables.env](https://prime.plane.so/deployment/assets/variables.env) – Stores environment variables for your deployment.
26+
27+
2. Click **+ Add stack** on Portainer.
28+
29+
3. Copy and paste the contents of `docker-compose.yml` into the editor.
30+
31+
4. Load environment variables from the `variables.env` file.
32+
33+
5. **Configure environment variables**
34+
Before deploying, edit the following variables:
35+
36+
- `DOMAIN_NAME` – Your application's domain name.
37+
- `APP_RELEASE_VERSION` – The version of Plane you want to deploy.
38+
- `SITE_ADDRESS` – The full domain name (FQDN) of your instance.
39+
- `WEB_URL`
40+
- `COR_ALLOWED_ORIGINS`
41+
- `CERT_EMAIL` – Email address for SSL certificate generation (only needed if you're setting up HTTPS).
42+
- `MACHINE_SIGNATURE` – A unique identifier for your machine. You can generate this with:
43+
```sh
44+
openssl rand -hex 16
45+
```
46+
or
47+
```sh
48+
uuidgen
49+
```
50+
51+
6. Click **Deploy the stack**.
52+
53+
That's it! Once the deployment is complete, Plane should be up and running on your configured domain.

0 commit comments

Comments
 (0)