Installation

Self-hosted only

This page applies only to self-hosted Klokku.
For the hosted version, create an account at app.klokku.com.

How to install Klokku

The easiest way to run self-hosted Klokku is using Docker Compose. Newest versions of Docker Desktop include Docker Compose built-in.

Quick Install

Run this command to download the configuration and start Klokku in a single step:

Linux

curl -sSL https://raw.githubusercontent.com/klokku/klokku/main/scripts/install.sh | bash

macOS

curl -sSL https://raw.githubusercontent.com/klokku/klokku/main/scripts/install.sh | bash

Windows

powershell -ExecutionPolicy Bypass -Command "iwr -useb https://raw.githubusercontent.com/klokku/klokku/main/scripts/install.ps1 | iex"

You can now access Klokku at http://localhost:8181.

Manual Install

1. Download docker-compose.yml to your local machine.

   curl -O https://raw.githubusercontent.com/klokku/klokku/refs/heads/main/docker-compose.yml

2. Download database initialization file to ./db/init.sql

   curl -sSL -o db/init.sql https://raw.githubusercontent.com/klokku/klokku/refs/heads/main/db/init.sql

3. Download .env.template file to your local machine and rename it to .env

   curl -o .env https://raw.githubusercontent.com/klokku/klokku/refs/heads/main/.env.template

4. Adjust the configuration in .env file to your needs.
5. Run the following command in the directory where you have placed the files:

   docker compose up -d

You can now access Klokku at http://localhost:8181.