Windows

danger

This version is not production-ready and may result in data loss. Use at your own risk.

No Backup - No Mercy!

System Requirements

• PostgreSQL (tested with v15.2): https://www.postgresql.org/download/windows/
• Node.js (tested with v18.14.2): https://nodejs.org/en/download/
• Windows PowerShell as Administrator

Install Planka (Nightly)

Create the installation directory:

mkdir C:\planka
cd C:\planka

Clone the repo:

git clone https://github.com/plankanban/planka.git .

Install dependencies and build the client:

npm install

cd client
npm run build

Set Up Symlinks

Instead of copying files, use symbolic links for easier updates:

New-Item -ItemType SymbolicLink -Path "C:\planka\server\public\asset-manifest.json" -Target "C:\planka\client\build\asset-manifest.json"
New-Item -ItemType SymbolicLink -Path "C:\planka\server\public\favicon.ico" -Target "C:\planka\client\build\favicon.ico"
New-Item -ItemType SymbolicLink -Path "C:\planka\server\public\logo192.png" -Target "C:\planka\client\build\logo192.png"
New-Item -ItemType SymbolicLink -Path "C:\planka\server\public\logo512.png" -Target "C:\planka\client\build\logo512.png"
New-Item -ItemType SymbolicLink -Path "C:\planka\server\public\manifest.json" -Target "C:\planka\client\build\manifest.json"
New-Item -ItemType SymbolicLink -Path "C:\planka\server\public\robots.txt" -Target "C:\planka\client\build\robots.txt"
New-Item -ItemType SymbolicLink -Path "C:\planka\server\public\static" -Target "C:\planka\client\build\static"
New-Item -ItemType SymbolicLink -Path "C:\planka\server\views\index.ejs" -Target "C:\planka\client\build\index.html"

Configure Environment Variables

Go to the server directory and copy the sample .env file:

cd C:\planka\server
cp .env.sample .env

Generate a secret key:

-join ((33..126) | Get-Random -Count 32 | % {[char]$_})

Note the output - you'll need it for the .env file.

Edit the .env file:

notepad.exe .env

Example .env configuration:

## Required

BASE_URL=http://YOUR_DOMAIN_NAME:YOUR_PORT
DATABASE_URL=postgresql://planka:YOUR_DATABASE_PASSWORD@localhost/planka
SECRET_KEY=YOUR_GENERATED_KEY

## Optional

...

DEFAULT_ADMIN_EMAIL=YOUR_ADMIN_EMAIL
DEFAULT_ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD
DEFAULT_ADMIN_NAME=YOUR_ADMIN_NAME
DEFAULT_ADMIN_USERNAME=YOUR_ADMIN_USERNAME

...

Start Planka

From the server directory, initialize the database and start Planka:

npm run db:init
npm start --prod

Access Planka

Once the services are running, browse to http://YOUR_DOMAIN_NAME:YOUR_PORT and log in as YOUR_ADMIN_EMAIL with the password YOUR_ADMIN_PASSWORD.

Troubleshooting

If you encounter issues during the build process on Windows, try:

git config --global core.autocrlf false

Then restart the installation process from the beginning.