Portainer Templates logo

Portainer Templates

Planka (stack) Planka (stack)

ProductivityProject Management

Open source Trello-like kanban board for project management built with React and Node.js. Source: https://github.com/plankanban/planka

Source details

Repo: plankanban/planka
Stars: 12.4k
Forks: 1k
Language: JavaScript
Latest: v2.2.1 · 5 days ago
Updated: 5 days ago
Website: planka.app/

Configuration

Type
Compose
Platform
linux
Env vars
BASE_URL=http://localhost:3000SECRET_KEY=DEFAULT_ADMIN_EMAIL=demo@demo.demoDEFAULT_ADMIN_PASSWORD=changemeDEFAULT_ADMIN_NAME=Admin UserDEFAULT_ADMIN_USERNAME=admin
Source
Repo

Source

Notes

BASE_URL must EXACTLY match the URL you open Planka at (localhost, IP, or domain) or login fails. Generate SECRET_KEY with 'openssl rand -hex 64'. The DEFAULT_ADMIN_* fields seed the first admin on first boot — log in with them, then change the password.

Services

planka

Configuration

Image
ghcr.io/plankanban/planka:latest
Ports
3000:1337
Volumes
/app/data : planka-data
Env vars
BASE_URL=${BASE_URL:-http://localhost:3000}DATABASE_URL=postgresql://postgres@postgres/plankaSECRET_KEY=${SECRET_KEY}DEFAULT_ADMIN_EMAIL=${DEFAULT_ADMIN_EMAIL:-demo@demo.demo}DEFAULT_ADMIN_PASSWORD=${DEFAULT_ADMIN_PASSWORD:-changeme}DEFAULT_ADMIN_NAME=${DEFAULT_ADMIN_NAME:-Admin User}DEFAULT_ADMIN_USERNAME=${DEFAULT_ADMIN_USERNAME:-admin}
Restart
unless-stopped

Image details

User: plankanban

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=plankaPOSTGRES_HOST_AUTH_METHOD=trust
Restart
unless-stopped

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Planka (stack)

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 Planka (stack), 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:
  planka:
    image: ghcr.io/plankanban/planka:latest
    restart: unless-stopped
    ports:
      - "3000:1337"
    environment:
      # BASE_URL must EXACTLY match the address you open Planka at, or login breaks
      - BASE_URL=${BASE_URL:-http://localhost:3000}
      - DATABASE_URL=postgresql://postgres@postgres/planka
      - SECRET_KEY=${SECRET_KEY}
      # Seeds the first admin on a fresh instance (Planka v2 has no built-in demo login)
      - DEFAULT_ADMIN_EMAIL=${DEFAULT_ADMIN_EMAIL:-demo@demo.demo}
      - DEFAULT_ADMIN_PASSWORD=${DEFAULT_ADMIN_PASSWORD:-changeme}
      - DEFAULT_ADMIN_NAME=${DEFAULT_ADMIN_NAME:-Admin User}
      - DEFAULT_ADMIN_USERNAME=${DEFAULT_ADMIN_USERNAME:-admin}
    volumes:
      - planka-data:/app/data
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      - POSTGRES_DB=planka
      - POSTGRES_HOST_AUTH_METHOD=trust
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres -d planka"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  planka-data:
  postgres-data:

Or deploy it directly from the source:

git clone https://github.com/lissy93/portainer-templates
cd portainer-templates
docker compose -f sources/stacks/planka.yml up -d

More install options in our documentation, or see plankanban/planka for app-specific guidance.

Container Documentation

postgres Documentation

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

Serve Planka (stack) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying planka-stack.example.com to http://planka:1337

Add this to your Caddyfile

planka-stack.example.com {
	reverse_proxy http://planka:1337
}

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.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3000
  • Stop the other service, or pick a different host port. In 3000:1337 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, planka can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3000

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/plankanban/planka:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "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 unless-stopped 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

Planka (stack) is a Compose stack, a set of containers (2 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 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • planka runs ghcr.io/plankanban/planka:latest, starts after postgres
  • postgres runs postgres:17-alpine

Ports

A port is the door the app answers on. A mapping like 3000:1337 means it's reachable on port 3000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 3000:1337

Volumes

A volume is where Planka (stack) 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:

  • /app/data kept in the planka-data volume Docker manages
  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages

Environment variables

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

  • BASE_URL, defaults to http://localhost:3000
  • DATABASE_URL, defaults to postgresql://postgres@postgres/planka
  • SECRET_KEY, pulled from your own environment
  • DEFAULT_ADMIN_EMAIL, defaults to demo@demo.demo
  • DEFAULT_ADMIN_PASSWORD, defaults to changeme
  • DEFAULT_ADMIN_NAME, defaults to Admin User
  • DEFAULT_ADMIN_USERNAME, defaults to admin
  • POSTGRES_DB, defaults to planka
  • POSTGRES_HOST_AUTH_METHOD, defaults to trust

Restart policy

The restart policy here is unless-stopped, so Docker restarts Planka (stack) after a crash or reboot, but leaves it off when you stop it on purpose. 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 planka) 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 Planka (stack) up. Add the template list to Portainer once, then deploying Planka (stack) is a click rather than a wall of config.