Skip to main content

Production Version

Docker Compose​

Steps to Install PLANKA​

  1. Create a Folder

    mkdir /opt/planka

  2. Download the docker-compose.yml

    curl -L https://raw.githubusercontent.com/plankanban/planka/master/docker-compose.yml -o /opt/planka/docker-compose.yml

  3. Generate a Secret Key

    openssl rand -hex 64

  4. Enter the Folder and Edit docker-compose.yml

    cd /opt/planka
    nano docker-compose.yml

    Paste your generated SECRET_KEY and change the BASE_URL.

  5. Create an Admin User

    docker compose run --rm planka npm run db:create-admin-user

    Sample output:

    Email: YOUR_ADMIN_EMAIL
    Password: YOUR_ADMIN_PASSWORD
    Name: ...
    Username (optional): ...

  6. Start Services

    docker compose up -d

Access PLANKA​

Once the services are running, browse to BASE_URL and log in as YOUR_ADMIN_EMAIL with the password YOUR_ADMIN_PASSWORD.

Additional Info​

If you're not using Docker volumes and prefer to directly link folders (bind mounts), you'll need to adjust the permissions of those folders. This ensures that the default user running the Node.js application (usually called "node" with a user ID of 1000) can make changes to the files and folders inside. Run the following command to adjust the permissions:

chown -R 1000:1000 /mnt/path