Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Docker Compose
description: Install Plane using Docker Compose. Step-by-step guide for deploying Plane with Docker on your server with all required services.
keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization
search: false
sidebar: false
head:
- - meta
- name: robots
content: noindex, nofollow
---

# Docker Compose

This guide shows you the steps to deploy a self-hosted instance of Plane using Docker.

## Install Plane

Plane Pro and Plane Business are enabled on this edition, so the Free plan on this edition is easier to trial our paid plans from.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Clarify the sentence about plan trialing.

The sentence is confusing and unclear. The phrasing "so the Free plan on this edition is easier to trial our paid plans from" is awkward and the logic is unclear.

Consider rephrasing for clarity, for example:

  • "This edition includes Plane Pro and Plane Business, making it easy to upgrade from the Free plan to trial our paid plans."
  • "Plane Pro and Plane Business are available on this edition, allowing you to easily trial paid plans starting from the Free plan."
🤖 Prompt for AI Agents
In `@docs/self-hosting/methods/install-methods-commercial/docker-compose.md` at
line 19, Replace the confusing sentence "Plane Pro and Plane Business are
enabled on this edition, so the Free plan on this edition is easier to trial our
paid plans from." with a clearer phrasing; for example use either "This edition
includes Plane Pro and Plane Business, making it easy to upgrade from the Free
plan to trial our paid plans." or "Plane Pro and Plane Business are available on
this edition, allowing you to easily trial paid plans starting from the Free
plan." Locate the sentence in the
docs/self-hosting/methods/install-methods-commercial/docker-compose.md content
and swap the text accordingly, keeping tone and tense consistent with
surrounding sentences.


### Prerequisites

- A virtual or on-prem machine with at least 2 vCPUs and 4 GB RAM (8 GB RAM recommended)
- `x64` AKA `AMD 64` or `AArch 64` AKA `ARM 64` CPUs
- Supported operating systems:
- Ubuntu
- Debian
- CentOS
- Amazon Linux 2 or Linux 2023

::: info
Ensure you're using the **latest version of Docker Compose**. Check your Docker Compose version with `docker-compose --version` and update if needed.
:::

### Procedure

1. `ssh` into your machine as the root user (or user with sudo access) per the norms of your hosting provider.
2. Run the command below:
```
curl -fsSL https://prime.plane.so/install/ | sh -
```
3. Follow the instructions on the terminal. Hit `Enter` or `Return` to continue.
4. Enter the domain name where you will access the Plane app in the format `domain.tld` or `subdomain.domain.tld`.
5. Choose one of the options below:
- **Express**: Plane installs with the default configurations.
- **Advanced**: You can customize the database, Redis, storage and other settings.
::: warning
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.
7. 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.
Loading