Portainer Templates logo

Portainer Templates

Plane Plane

Stack

Project ManagementProductivity

Project management tool from the future. An open-source software development tool to manage issues, sprints, and product roadmaps with peace of mind.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

plane-web

Configuration

Command
/usr/local/bin/start.sh web/server.js web
Restart
always
Build
[object Object]

plane-space

Configuration

Command
/usr/local/bin/start.sh space/server.js space
Restart
always
Build
[object Object]

plane-api

Configuration

Command
./bin/takeoff
Restart
always
Build
[object Object]

plane-worker

Configuration

Command
./bin/worker
Restart
always
Build
[object Object]

plane-beat-worker

Configuration

Command
./bin/beat
Restart
always
Build
[object Object]

plane-db

Configuration

Image
postgres:15.2-alpine
Command
postgres -c 'max_connections=1000'
Volumes
/var/lib/postgresql/data : /portainer/Files/AppData/Config/plane/pgdata
Env vars
POSTGRES_USER=${PGUSER}POSTGRES_DB=${PGDATABASE}POSTGRES_PASSWORD=${PGPASSWORD}PGDATA=/var/lib/postgresql/data
Restart
always

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 3 hours ago
Status: active

plane-redis

Configuration

Image
redis:6.2.7-alpine
Volumes
/data : /portainer/Files/AppData/Config/plane/redisdata
Restart
always

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

plane-minio

Configuration

Image
minio/minio
Command
server /export --console-address ":9090"
Volumes
/export : /portainer/Files/AppData/Config/plane/uploads
Env vars
MINIO_ROOT_USER=${AWS_ACCESS_KEY_ID}MINIO_ROOT_PASSWORD=${AWS_SECRET_ACCESS_KEY}
Restart
always

Image details

Pulls: 1.8B
User: minio
Created: Jun 21, 2016
Updated: 11 months ago
Status: archived

createbuckets

Configuration

Image
minio/mc
Entrypoint
/bin/sh -c " /usr/bin/mc config host add plane-minio http://plane-minio:9000 \$AWS_ACCESS_KEY_ID \$AWS_SECRET_ACCESS_KEY; /usr/bin/mc mb plane-minio/\$AWS_S3_BUCKET_NAME; /usr/bin/mc anonymous set download plane-minio/\$AWS_S3_BUCKET_NAME; exit 0; "

Image details

Pulls: 153.5M
User: minio
Created: Jan 01, 2017
Updated: 11 months ago
Status: archived

Standalone Install

Select an install method, to see config/commands for deploying Plane

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Plane, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  plane-web:
    container_name: plane-web
    build:
      context: .
      dockerfile: ./web/Dockerfile.web
      args:
        DOCKER_BUILDKIT: 1
    restart: always
    command: /usr/local/bin/start.sh web/server.js web
    depends_on:
      - plane-api
      - plane-worker

  plane-space:
    container_name: plane-space
    build:
      context: .
      dockerfile: ./space/Dockerfile.space
      args:
        DOCKER_BUILDKIT: 1
    restart: always
    command: /usr/local/bin/start.sh space/server.js space
    depends_on:
      - plane-api
      - plane-worker
      - plane-web

  plane-api:
    container_name: plane-api
    build:
      context: ./apiserver
      dockerfile: Dockerfile.api
      args:
        DOCKER_BUILDKIT: 1
    restart: always
    command: ./bin/takeoff
    env_file:
      - ./apiserver/.env
    depends_on:
      - plane-db
      - plane-redis

  plane-worker:
    container_name: plane-bgworker
    build:
      context: ./apiserver
      dockerfile: Dockerfile.api
      args:
        DOCKER_BUILDKIT: 1
    restart: always
    command: ./bin/worker
    env_file:
      - ./apiserver/.env
    depends_on:
      - plane-api
      - plane-db
      - plane-redis

  plane-beat-worker:
    container_name: plane-beatworker
    build:
      context: ./apiserver
      dockerfile: Dockerfile.api
      args:
        DOCKER_BUILDKIT: 1
    restart: always
    command: ./bin/beat
    env_file:
      - ./apiserver/.env
    depends_on:
      - plane-api
      - plane-db
      - plane-redis

  plane-db:
    container_name: plane-db
    image: postgres:15.2-alpine
    restart: always
    command: postgres -c 'max_connections=1000'
    volumes:
      - /portainer/Files/AppData/Config/plane/pgdata:/var/lib/postgresql/data
    env_file:
      - .env
    environment:
      POSTGRES_USER: ${PGUSER}
      POSTGRES_DB: ${PGDATABASE}
      POSTGRES_PASSWORD: ${PGPASSWORD}
      PGDATA: /var/lib/postgresql/data

  plane-redis:
    container_name: plane-redis
    image: redis:6.2.7-alpine
    restart: always
    volumes:
      - /portainer/Files/AppData/Config/plane/redisdata:/data

  plane-minio:
    container_name: plane-minio
    image: minio/minio
    restart: always
    command: server /export --console-address ":9090"
    volumes:
      - /portainer/Files/AppData/Config/plane/uploads:/export
    environment:
      MINIO_ROOT_USER: ${AWS_ACCESS_KEY_ID}
      MINIO_ROOT_PASSWORD: ${AWS_SECRET_ACCESS_KEY}

  createbuckets:
    image: minio/mc
    entrypoint: >
      /bin/sh -c " /usr/bin/mc config host add plane-minio http://plane-minio:9000 \$AWS_ACCESS_KEY_ID \$AWS_SECRET_ACCESS_KEY; /usr/bin/mc mb plane-minio/\$AWS_S3_BUCKET_NAME; /usr/bin/mc anonymous set download plane-minio/\$AWS_S3_BUCKET_NAME; exit 0; "
    env_file:
      - .env
    depends_on:
      - plane-minio

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/plane.yml up -d

More install options in our documentation.

Container Documentation

plane-db Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

plane-redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

plane-minio Documentation

Multi-Cloud Object Storage

createbuckets Documentation

Minio Client (mc) provides a modern alternative to UNIX commands like ls, cat, cp, mirror, diff etc.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/plane/pgdata (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull postgres:15.2-alpine

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Plane is a Compose stack, a set of containers (9 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 9 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • plane-web, starts after plane-api, plane-worker
  • plane-space, starts after plane-api, plane-worker, plane-web
  • plane-api, starts after plane-db, plane-redis
  • plane-worker, starts after plane-api, plane-db, plane-redis
  • plane-beat-worker, starts after plane-api, plane-db, plane-redis
  • plane-db runs postgres:15.2-alpine
  • plane-redis runs redis:6.2.7-alpine
  • plane-minio runs minio/minio
  • createbuckets runs minio/mc, starts after plane-minio

Volumes

A volume is where Plane keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/postgresql/data from /portainer/Files/AppData/Config/plane/pgdata on the host
  • /data from /portainer/Files/AppData/Config/plane/redisdata on the host
  • /export from /portainer/Files/AppData/Config/plane/uploads on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Plane takes 6 of them, all with defaults you can leave alone or tweak:

  • POSTGRES_USER, pulled from your own environment
  • POSTGRES_DB, pulled from your own environment
  • POSTGRES_PASSWORD, pulled from your own environment
  • PGDATA, defaults to /var/lib/postgresql/data
  • MINIO_ROOT_USER, pulled from your own environment
  • MINIO_ROOT_PASSWORD, pulled from your own environment

Restart policy

The restart policy here is always, so Docker brings Plane back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like plane-web) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Plane up. Add the template list to Portainer once, then deploying Plane is a click rather than a wall of config.