Installing and Updating

This section provides guidance to install kora using Docker.

Requirements

To run kora on your computer you will need to first install:

• Docker

• Git

Installation

Tip

Windows users

A step-by-step video guide is available for installing kora on Windows: watch the installation guide.

Open Git Bash (Windows), or from the terminal (Mac / Linux), paste:

git clone --depth 1 https://github.com/kofm/kora-app kora
cd kora
./ko start

On first start, it will generate the required configuration file, starts the services, and offers to create an administrator user.

After startup, open http://localhost:8000 in a browser and log in with the user you created. The application can only be accessed from the same machine, by default (for changing that see Configuration).

Admin Account Creation

If you didn’t create an administrator account during the installation, you can create an administrator account using the ko utility. Open Git Bash (Windows), or from the terminal (Mac / Linux), and navigate to the installation directory (e.g. assuming Windows installation in C:/kora):

cd C:/kora
./ko createsuperuser

Updating

When a new version is released, update the application using the convenience script ko. Open Git Bash (Windows), or from the terminal (Mac / Linux), and navigate to the installation directory (e.g. assuming Windows installation in C:/kora):

cd C:/kora
./ko

From the menu, select the option to update the application.