Skip to main content

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​

Install Planka​

First we have to prepare some stuff our installation directory is C:\planka

mkdir C:\planka
cd C:\planka

Clone the repository into the directory.

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

Install dependencies for client and build it.

npm install

cd client
npm run build

Symlink Fun Normaly we have to copy everything from client\build to server\public and build\index.html to server\views\index.ejs, we don't want to go this way. instead we are using symlinks, this makes updating way easier and faster.

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 into the server directory and edit the .env file

First we have to copy the .env.sample file

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

Before we open the .env file, we need a screct_key you can generate one using this Powershell command

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

Note the output down

Edit .env file

notepad.exe .env

Your .env file should look like this

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

## Optional

# TRUST_PROXY=0
# TOKEN_EXPIRES_IN=365 # In days

# related: https://github.com/knex/knex/issues/2354
# As knex does not pass query parameters from the connection string we
# have to use environment variables in order to pass the desired values, e.g.
# PGSSLMODE=<value>

# Configure knex to accept SSL certificates
# KNEX_REJECT_UNAUTHORIZED_SSL_CERTIFICATE=false

DEFAULT_ADMIN_EMAIL=YOUR_ADMIN_EMAIL # Do not remove if you want to prevent this user from being edited/deleted
DEFAULT_ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD
DEFAULT_ADMIN_NAME=YOUR_ADMIN_NAME
DEFAULT_ADMIN_USERNAME=YOUR_ADMIN_USERNAME

# OIDC_ISSUER=
# OIDC_CLIENT_ID=
# OIDC_CLIENT_SECRET=
# OIDC_SCOPES=openid email profile
# OIDC_ADMIN_ROLES=admin
# OIDC_ROLES_ATTRIBUTE=groups
# OIDC_IGNORE_ROLES=true

## Do not edit this

TZ=UTC

Start Planka the first Time​

in the C:\planka\server directory just type

npm run db:init
npm start --prod

Now you can browse to http://YOUR_DOMAIN_NAME:YOUR_PORT and login as YOUR_ADMIN_EMAIL with password YOUR_ADMIN_PASSWORD

Problems​

It's possible that you are running into an issue while building Planka in Windows

Use this command, should fix it.

git config --global core.autocrlf false

After that, you need restart the whole installation