Skip to content

Commit 49a7fc8

Browse files
fix: formatting (#205)
1 parent 40ff374 commit 49a7fc8

3 files changed

Lines changed: 43 additions & 39 deletions

File tree

docs/self-hosting/methods/coolify.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using C
1717

1818
### Procedure
1919

20-
1. **Download the required depoyment files**
20+
1. **Download the required deployment files**
2121
- `coolify-compose.yml` – Defines Plane's services and dependencies.
2222

2323
```bash

docs/self-hosting/methods/docker-swarm.md

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,62 +4,66 @@ description: Deploy Plane on Docker Swarm cluster. Guide for running Plane in a
44
keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization
55
---
66

7-
87
# Deploy Plane with Docker Swarm <Badge type="info" text="Commercial Edition" />
98

109
This guide shows you the steps to deploy a self-hosted instance of the Plane Commercial Edition using Docker Swarm.
1110

1211
## Install Plane
1312

1413
### Prerequisites
15-
- Before you get started, make sure you have a Docker Swarm environment set up and ready to go.
16-
- Your setup should support either amd64 or arm64 architectures.
14+
15+
- Before you get started, make sure you have a Docker Swarm environment set up and ready to go.
16+
- Your setup should support either amd64 or arm64 architectures.
1717

1818
### Procedure
1919

20-
1. **Download the required depoyment files**
21-
- `swarm-compose.yml` – Defines Plane's services and dependencies.
22-
```bash
23-
curl -fsSL https://prime.plane.so/releases/<plane-version>/swarm-compose.yml -o swarm-compose.yml
24-
```
25-
- `variables.env` – Stores environment variables for your deployment.
26-
```bash
27-
curl -fsSL https://prime.plane.so/releases/<plane-version>/variables.env -o plane.env
28-
```
29-
::: warning
30-
The `<plane-version>` value should be v1.8.3 or higher.
31-
:::
20+
1. **Download the required deployment files**
21+
- `swarm-compose.yml` – Defines Plane's services and dependencies.
3222

33-
2. **Configure environment variables**
34-
Before deploying, edit the `variables.env` file in your preferred text editor and update the following values:
23+
```bash
24+
curl -fsSL https://prime.plane.so/releases/<plane-version>/swarm-compose.yml -o swarm-compose.yml
25+
```
26+
27+
- `variables.env` – Stores environment variables for your deployment.
3528

36-
- `DOMAIN_NAME` – (required) Your application's domain name.
37-
- `SITE_ADDRESS` – (required) The full domain name (FQDN) of your instance.
38-
- `MACHINE_SIGNATURE` – (required) A unique identifier for your machine. You can generate this by running below code in terminal:
39-
```sh
40-
sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env
41-
```
42-
- `CERT_EMAIL` – (optional) Email address for SSL certificate generation (only needed if you're setting up HTTPS).
29+
```bash
30+
curl -fsSL https://prime.plane.so/releases/<plane-version>/variables.env -o plane.env
31+
```
32+
33+
::: warning
34+
The `<plane-version>` value should be v1.8.3 or higher.
35+
:::
36+
37+
2. **Configure environment variables**
38+
Before deploying, edit the `variables.env` file in your preferred text editor and update the following values:
39+
- `DOMAIN_NAME` – (required) Your application's domain name.
40+
- `SITE_ADDRESS` – (required) The full domain name (FQDN) of your instance.
41+
- `MACHINE_SIGNATURE` – (required) A unique identifier for your machine. You can generate this by running below code in terminal:
42+
```sh
43+
sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env
44+
```
45+
- `CERT_EMAIL` – (optional) Email address for SSL certificate generation (only needed if you're setting up HTTPS).
4346
4447
3. **Configure external DB, Redis, and RabbitMQ**
45-
::: warning
46-
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.
47-
:::
48+
::: warning
49+
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.
50+
:::
4851
- `DATABASE_URL` – Connection string for your external database.
4952
- `REDIS_URL` – Connection string for your external Redis instance.
5053
- `AMQP_URL` – Connection string for your external RabbitMQ server.
5154
55+
4. **Load the environment variables**
56+
57+
```bash
58+
set -o allexport; source <path-to variables.env>; set +o allexport;
59+
```
5260
53-
3. **Load the environment variables**
54-
```bash
55-
set -o allexport; source <path-to variables.env>; set +o allexport;
56-
```
61+
5. **Deploy the stack**
5762
58-
4. **Deploy the stack**
59-
```bash
60-
docker stack deploy -c <path-to swarm-compose.yml> plane
61-
```
63+
```bash
64+
docker stack deploy -c <path-to swarm-compose.yml> plane
65+
```
6266
63-
That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain.
67+
That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain.
6468

65-
5. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features.
69+
6. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features.

docs/self-hosting/methods/portainer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using P
1717

1818
### Procedure
1919

20-
1. **Download the required depoyment files**
20+
1. **Download the required deployment files**
2121
- `portainer-compose.yml` – Defines Plane's services and dependencies.
2222
```bash
2323
curl -fsSL https://prime.plane.so/releases/<plane-version>/portainer-compose.yml -o portainer-compose.yml

0 commit comments

Comments
 (0)