|
| 1 | +--- |
| 2 | +title: Docker Compose |
| 3 | +description: Install Plane using Docker Compose. Step-by-step guide for deploying Plane with Docker on your server with all required services. |
| 4 | +keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization |
| 5 | +search: false |
| 6 | +sidebar: false |
| 7 | +head: |
| 8 | + - - meta |
| 9 | + - name: robots |
| 10 | + content: noindex, nofollow |
| 11 | +--- |
| 12 | + |
| 13 | +# Docker Compose |
| 14 | + |
| 15 | +This guide shows you the steps to deploy a self-hosted instance of Plane using Docker. |
| 16 | + |
| 17 | +## Install Plane |
| 18 | + |
| 19 | +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. |
| 20 | + |
| 21 | +### Prerequisites |
| 22 | + |
| 23 | +- A virtual or on-prem machine with at least 2 vCPUs and 4 GB RAM (8 GB RAM recommended) |
| 24 | +- `x64` AKA `AMD 64` or `AArch 64` AKA `ARM 64` CPUs |
| 25 | +- Supported operating systems: |
| 26 | + - Ubuntu |
| 27 | + - Debian |
| 28 | + - CentOS |
| 29 | + - Amazon Linux 2 or Linux 2023 |
| 30 | + |
| 31 | +::: info |
| 32 | +Ensure you're using the **latest version of Docker Compose**. Check your Docker Compose version with `docker-compose --version` and update if needed. |
| 33 | +::: |
| 34 | + |
| 35 | +### Procedure |
| 36 | + |
| 37 | +1. `ssh` into your machine as the root user (or user with sudo access) per the norms of your hosting provider. |
| 38 | +2. Run the command below: |
| 39 | + ``` |
| 40 | + curl -fsSL https://prime.plane.so/install/ | sh - |
| 41 | + ``` |
| 42 | +3. Follow the instructions on the terminal. Hit `Enter` or `Return` to continue. |
| 43 | +4. Enter the domain name where you will access the Plane app in the format `domain.tld` or `subdomain.domain.tld`. |
| 44 | +5. Choose one of the options below: |
| 45 | + - **Express**: Plane installs with the default configurations. |
| 46 | + - **Advanced**: You can customize the database, Redis, storage and other settings. |
| 47 | + ::: warning |
| 48 | + 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. |
| 49 | + ::: |
| 50 | +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. |
| 51 | +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. |
0 commit comments