Back to all templates
Planka logo

Planka

Application256MB+ RAM

Elegant open-source project tracking tool built with React and Redux

kanbanproject-managementtrello-alternativeboards

Deploy Planka in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Planka

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Planka on a VPS with Server Compass

Use the Planka template in Server Compass to deploy a self-hosted real-time Kanban board stack with PostgreSQL on your VPS, then verify the Planka web UI in a browser.

About 7 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Planka app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Planka

Use the template picker search to find Planka in the Server Compass template catalog.

Searching for Planka in the Server Compass template picker
4
Step 4

Select the Planka template

Choose the Planka template. Server Compass fills the Planka image, host port, admin credentials, generated secrets, PostgreSQL, and persistent attachment volumes.

Planka template selected in Server Compass
5
Step 5

Review the Planka settings

Confirm the app name and compose services. In this run, the app was named planka-demo and used host port 3001.

Reviewing Planka project settings and compose services
6
Step 6

Deploy Planka

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing Planka environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Planka image, starts the container, and verifies the stack.

Server Compass deploying the Planka template on the VPS
8
Step 8

Confirm Planka is running

After deployment finishes, return to the Apps tab and confirm the Planka app is marked Running with its application URL available.

Planka template running in the Server Compass Apps tab
9
Step 9

Open Planka in the browser

Open the application URL in a browser. The Planka web UI confirms the site is reachable.

The deployed Planka web UI loaded in a browser

After Planka Opens

  • Sign in with the configured Planka admin account before production use.
  • Configure projects, boards, HTTPS, email, and user access before production use.
  • Add a domain and HTTPS before exposing the Kanban board dashboard to users.
  • Back up the Planka PostgreSQL and attachment volumes before relying on it for production boards.

Verified Result

The Planka web UI loaded successfully in a browser.

Planka deployment questions

What does the Planka template deploy?

It deploys Planka with PostgreSQL backing services plus persistent database volumes.

Which port did the tutorial use?

The tutorial used host port 3001, which maps to the Planka web server inside the container on the same port.

Why does the guide stop at the first-run web UI?

The tutorial verifies the clean first-run web UI because real projects, boards, users, and access rules depend on the production server.

Should this become a blog post?

No. The deployment guide should live on the Planka template detail page and be linked from the reusable template deployment docs page.

DIY Deployment

Self-Host Planka with Docker

Take the DIY route and deploy Planka on your own server using Docker.

1

Remote into Your Server

Initiate a secure shell connection to your server using the command below.

terminal
# Connect to your VPS
ssh root@your-server-ip

# Or with a specific SSH key
ssh -i ~/.ssh/your-key root@your-server-ip

First time? Docker required! Install it with: curl -fsSL https://get.docker.com | sh

2

Create the App Directory

Organize your deployment by creating a dedicated project folder.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/planka
cd ~/apps/planka
3

Write Your docker-compose.yml

Create a new docker-compose.yml file and paste this configuration:

docker-compose.yml
services:
  planka:
    image: ghcr.io/plankanban/planka:latest
    ports:
      - "3000:1337"
    environment:
      - BASE_URL=http://localhost:3000
      - DATABASE_URL=postgresql://postgres:<your-db-password>@postgres/planka
      - SECRET_KEY=<your-secret-key>
      - [email protected]
      - DEFAULT_ADMIN_PASSWORD=<your-admin-password>
      - DEFAULT_ADMIN_NAME=Admin
      - DEFAULT_ADMIN_USERNAME=admin
    volumes:
      - planka_avatars:/app/public/user-avatars
      - planka_backgrounds:/app/public/project-background-images
      - planka_attachments:/app/private/attachments
    restart: unless-stopped
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:16-alpine
    environment:
      - POSTGRES_DB=planka
      - POSTGRES_PASSWORD=<your-db-password>
    volumes:
      - planka_db:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres -d planka"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 30s

volumes:
  planka_avatars:
  planka_backgrounds:
  planka_attachments:
  planka_db:
Configurable Options
PORTHost port to expose(default: 3000)
DB_PASSWORDDatabase password
SECRET_KEYSession secret
ADMIN_EMAILAdmin email(default: [email protected])
ADMIN_PASSWORDAdmin password
4

Launch the Containers

Start the services and tail the logs to verify startup.

terminal
# Spin up containers
docker compose up -d

# Verify deployment
docker compose ps

# Check logs for errors
docker compose logs -f
5

Open Firewall Ports

Open the required port in your firewall to allow access.

terminal
# Allow the application port through firewall
sudo ufw allow 3000/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:3000
Skip the Terminal

Want the easy way? Try Server Compass.

Forget SSH and YAML files. Deploy Planka visually with Server Compass in just a few clicks.

  • Visual config editor
  • Instant deployment
  • Automatic HTTPS
  • Smooth updates
  • Live monitoring
  • Quick rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying Planka with Server Compass, complete these steps to finish setup

1

Log in with admin credentials

2

Create your first project and board

3

Invite team members

Need help? Check out our documentation for detailed guides.

Planka FAQ

Common questions about self-hosting Planka

How do I deploy Planka with Server Compass?

Simply download Server Compass, connect to your VPS, and select Planka from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Planka?

Planka requires a minimum of 256MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Planka data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Planka backup and restore procedures.

How do I update Planka to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Planka image will be pulled and deployed with zero downtime.

Is Planka free to self-host?

Planka is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Planka?

Download Server Compass and deploy Planka to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass