Skip to main content

Deploy Plane with Portainer • Commercial Edition

This guide shows you how to deploy a self-hosted instance of Plane using Portainer.

Install Plane​

Prerequisites​

  • A Portainer environment set up and ready
  • Support for amd64 or arm64 architectures

Procedure​

  1. Download the required deployment files

    • portainer-compose.yml — Defines Plane's services and dependencies. 
      curl -fsSL https://prime.plane.so/releases/<plane-version>/portainer-compose.yml -o portainer-compose.yml
    • variables.env — Stores environment variables for your deployment. 
      curl -fsSL https://prime.plane.so/releases/<plane-version>/variables.env -o plane.env
      warning

      The <plane-version> value should be v1.8.2 or higher.

  2. Click + Add stack in Portainer.

  3. Copy and paste the contents of portainer-compose.yml into the editor.

  4. Load environment variables from the variables.env file.

  5. Configure environment variables Edit the following variables:

    • DOMAIN_NAME — (required) Your application's domain name
    • SITE_ADDRESS — (required) The full domain name (FQDN) of your instance
    • MACHINE_SIGNATURE — (required) Unique identifier for your machine. Generate with: 
      sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env
    • CERT_EMAIL — (optional) Email for SSL certificate generation (needed for HTTPS)

  6. Configure external DB, Redis, and RabbitMQ

    warning

    For production, configure external database and storage to ensure data security and reliability. Relying on local storage increases the risk of data loss and service disruption.

    • DATABASE_URL — Connection string for your external database
    • REDIS_URL — Connection string for your external Redis instance
    • AMQP_URL — Connection string for your external RabbitMQ server

  7. Click Deploy the stack.

Once deployment is complete, Plane should be running on your configured domain.