Planka (container)

Content Management Business

Planka is an elegant open source project tracking tool.

Image details

Pulls: 81.4k

Architectures: amd64, arm64

Image size: 89 MB

Latest: 2.1.1

User: linuxserverci

Created: Sep 12, 2024

Updated: 4 days ago

Status: active

Source details

Repo: plankanban/planka

Stars: 12.3k

Forks: 1k

Language: JavaScript

Latest: 2.1.1 · 3 months ago

Updated: 22 days ago

Website: planka.app/

Configuration

Type

Container

Platform

linux

Image

linuxserver/planka:latest

Ports

1337:1337/tcp

Volumes

/config : /srv/lsio/planka/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTCBASE_URL=https://planka.example.comDATABASE_URL=postgresql://user:password@planka-db:5432/planka[email protected]DEFAULT_ADMIN_USERNAME=demoDEFAULT_ADMIN_PASSWORD=demoDEFAULT_ADMIN_NAME=Demo UserSECRET_KEY=notasecretkeyTRUST_PROXY=falseDEFAULT_LANGUAGE=en-US

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/planka/config

Installation

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

docker run -d --name Planka \
  -p 1337:1337/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -e 'BASE_URL=https://planka.example.com' \
  -e 'DATABASE_URL=postgresql://user:password@planka-db:5432/planka' \
  -e '[email protected]' \
  -e 'DEFAULT_ADMIN_USERNAME=demo' \
  -e 'DEFAULT_ADMIN_PASSWORD=demo' \
  -e 'DEFAULT_ADMIN_NAME=Demo User' \
  -e 'SECRET_KEY=notasecretkey' \
  -e 'TRUST_PROXY=false' \
  -e 'DEFAULT_LANGUAGE=en-US' \
  -v /srv/lsio/planka/config:/config \
  --restart=unless-stopped \
  linuxserver/planka:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  planka-container:
    image: linuxserver/planka:latest
    ports:
      - 1337:1337/tcp
    volumes:
      - /srv/lsio/planka/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      BASE_URL: https://planka.example.com
      DATABASE_URL: postgresql://user:password@planka-db:5432/planka
      DEFAULT_ADMIN_EMAIL: [email protected]
      DEFAULT_ADMIN_USERNAME: demo
      DEFAULT_ADMIN_PASSWORD: demo
      DEFAULT_ADMIN_NAME: Demo User
      SECRET_KEY: notasecretkey
      TRUST_PROXY: 'false'
      DEFAULT_LANGUAGE: en-US
    restart: unless-stopped

Save this file as planka-container-stack.yml, then from a manager node, run docker stack deploy -c planka-container-stack.yml planka-container

version: '3.8'
services:
  planka-container:
    image: linuxserver/planka:latest
    ports:
      - 1337:1337/tcp
    volumes:
      - /srv/lsio/planka/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      BASE_URL: https://planka.example.com
      DATABASE_URL: postgresql://user:password@planka-db:5432/planka
      DEFAULT_ADMIN_EMAIL: [email protected]
      DEFAULT_ADMIN_USERNAME: demo
      DEFAULT_ADMIN_PASSWORD: demo
      DEFAULT_ADMIN_NAME: Demo User
      SECRET_KEY: notasecretkey
      TRUST_PROXY: 'false'
      DEFAULT_LANGUAGE: en-US
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

`planka-container-deployment.yaml`

apiVersion: apps/v1
kind: Deployment
metadata:
  name: planka-container
  labels:
    app: planka-container
spec:
  replicas: 1
  selector:
    matchLabels:
      app: planka-container
  template:
    metadata:
      labels:
        app: planka-container
    spec:
      containers:
        - name: planka-container
          image: linuxserver/planka:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: BASE_URL
              value: https://planka.example.com
            - name: DATABASE_URL
              value: postgresql://user:password@planka-db:5432/planka
            - name: DEFAULT_ADMIN_EMAIL
              value: [email protected]
            - name: DEFAULT_ADMIN_USERNAME
              value: demo
            - name: DEFAULT_ADMIN_PASSWORD
              value: demo
            - name: DEFAULT_ADMIN_NAME
              value: Demo User
            - name: SECRET_KEY
              value: notasecretkey
            - name: TRUST_PROXY
              value: 'false'
            - name: DEFAULT_LANGUAGE
              value: en-US
          ports:
            - containerPort: 1337
              protocol: TCP
          volumeMounts:
            - name: planka-container-data-0
              mountPath: /config
      volumes:
        - name: planka-container-data-0
          hostPath:
            path: /srv/lsio/planka/config

`planka-container-service.yaml`

apiVersion: v1
kind: Service
metadata:
  name: planka-container
spec:
  type: LoadBalancer
  selector:
    app: planka-container
  ports:
    - name: 1337-tcp
      port: 1337
      targetPort: 1337
      protocol: TCP

Save this file as ~/.config/containers/systemd/planka-container.container

[Unit]
Description=Planka (container)

[Container]
Image=linuxserver/planka:latest
ContainerName=planka-container
PublishPort=1337:1337/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=BASE_URL=https://planka.example.com
Environment=DATABASE_URL=postgresql://user:password@planka-db:5432/planka
Environment[email protected]
Environment=DEFAULT_ADMIN_USERNAME=demo
Environment=DEFAULT_ADMIN_PASSWORD=demo
Environment="DEFAULT_ADMIN_NAME=Demo User"
Environment=SECRET_KEY=notasecretkey
Environment=TRUST_PROXY=false
Environment=DEFAULT_LANGUAGE=en-US
Volume=/srv/lsio/planka/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start planka-container

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

For app-specific guidance, check Planka (container)'s own repo at plankanban/planka

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/planka

Planka is an elegant open source project tracking tool.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/planka:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Available | Tag | | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ |

Application Setup

Web UI is accessible at http://SERVERIP:PORT. An external postgres database is required.
Once you've run your first time setup you can safely remove the DEFAULT environment variables. They will overwrite any changes made to the default user in the web UI (passwords, display names, etc.) on startup if left in place.
Migration from Official Image
Copy your user-avatars, background-images, and attachments folders to your new /config mount so that it looks like:
/config ├── attachments └── images ├── background-images └── user-avatars
Read-Only Operation
This image can be run with a read-only container filesystem. For details please read the docs.

Non-Root Operation

This image can be run with a non-root user. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  planka:
    image: lscr.io/linuxserver/planka:latest
    container_name: planka
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - BASE_URL=https://planka.example.com
      - DATABASE_URL=postgresql://user:password@planka-db:5432/planka
      - [email protected]
      - DEFAULT_ADMIN_USERNAME=demo
      - DEFAULT_ADMIN_PASSWORD=demo
      - "DEFAULT_ADMIN_NAME=Demo User"
      - SECRET_KEY=notasecretkey
      - TRUST_PROXY=false
      - DEFAULT_LANGUAGE=en-US #optional
    volumes:
      - /path/to/planka/data:/config
    ports:
      - 1337:1337
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=planka \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e BASE_URL=https://planka.example.com \
  -e DATABASE_URL=postgresql://user:password@planka-db:5432/planka \
  -e [email protected] \
  -e DEFAULT_ADMIN_USERNAME=demo \
  -e DEFAULT_ADMIN_PASSWORD=demo \
  -e DEFAULT_ADMIN_NAME="Demo User" \
  -e SECRET_KEY=notasecretkey \
  -e TRUST_PROXY=false \
  -e DEFAULT_LANGUAGE=en-US `#optional` \
  -p 1337:1337 \
  -v /path/to/planka/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/planka:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
| Parameter | Function | | :----: | --- | | -p 1337:1337 | Planka web UI. | | -e PUID=1000 | for UserID - see below for explanation | | -e PGID=1000 | for GroupID - see below for explanation | | -e TZ=Etc/UTC | specify a timezone to use, see this list. | | -e BASE_URL=https://planka.example.com | The URL you will use to access planka including protocol, and port if not 80/443. | | -e DATABASE_URL=postgresql://user:password@planka-db:5432/planka | Postgres database URL. Special characters must be url encoded. | | -e [email protected] | Email address for default user. | | -e DEFAULT_ADMIN_USERNAME=demo | Username for default user. | | -e DEFAULT_ADMIN_PASSWORD=demo | Password for default user. | | -e DEFAULT_ADMIN_NAME=Demo User | Display name for default user. | | -e SECRET_KEY=notasecretkey | Session encryption key, recommended 32-64 character alphanumeric. | | -e TRUST_PROXY=false | Set to true to trust upstream proxies if reverse proxying. | | -e DEFAULT_LANGUAGE=en-US | This sets the default language for sending notifications per user (if a user hasn't selected a language) and per board. | | -v /config | Local path for planka config files. | | --read-only=true | Run container with a read-only filesystem. Please read the docs. | | --user=1000:1000 | Run container with a non-root user. Please read the docs. |

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:

```bash
docker exec -it planka /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f planka
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' planka
```

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/planka:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull planka
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d planka
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/planka:latest
```

Stop the running container:

```bash
docker stop planka
```

Delete the container:

```bash
docker rm planka
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-planka.git
cd docker-planka
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/planka:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
05.07.26: - Rebase to Alpine 3.24.
13.02.26: - Rebase to Alpine 3.23. Updates for v2. Users should update TRUST_PROXY to use true/false instead of 1/0.
12.01.25: - Rebase to Alpine 3.21.
18.09.24: - Update default user docs.
12.09.24: - Initial Release.

Serve Planka (container) 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.

Proxy Domain App port Upstream

Proxying planka-container.example.com to http://Planka:1337

Add this to your Caddyfile

planka-container.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 Planka
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:1337 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :1337
Stop the other service, or pick a different host port. In 1337: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:1337. 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 1337

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 /srv/lsio/planka/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/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.

This image supports: amd64, arm64
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 Planka --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

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

Bug within the app: Open an issue on plankanban/planka
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

Similar apps

Bookstack (container) Content Management

Dokuwiki Content Management

Grav Content Management

Hedgedoc Content Management

Joplin Content Management

Kasm Business

Kimai Business

Netbox Business

Planka (container)

Image details

Source details

Configuration

Notes

Installation

Via Portainer

Template Import URL

Docker Run

Docker Compose

Docker Swarm

Kubernetes

planka-container-deployment.yaml

planka-container-service.yaml

Podman Quadlet

Alternative Methods

Container Documentation