Windows

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

Create the installation directory:

mkdir C:\planka
cd C:\planka

Download and extract the prebuilt version of PLANKA:

curl -O https://github.com/plankanban/planka/releases/latest/download/planka-prebuild.zip
Expand-Archive planka-prebuild.zip -DestinationPath C:\
rm planka-prebuild.zip

Install dependencies:

npm install

Configure Environment Variables

Copy the sample .env file:

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

...

Initialize the Database and Create an Admin User

Initialize the database:

npm run db:init

Create an admin user:

npm run db:create-admin-user

Sample output:

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

Start PLANKA

From the C:\planka directory, start PLANKA:

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.