Installation

Docker

By far the easiest way to get up and running with Koito is using docker. Here is an example Docker Compose file to get you up and running in minutes:

compose.yaml

services:
  koito:
    image: gabehf/koito:latest
    container_name: koito
    ports:
      - "4110:4110"
    volumes:
      - ./koito:/etc/koito
    restart: unless-stopped

Note

Koito uses SQLite for all new installations as of v0.2.1. If you are running a version older than that, you will need to set KOITO_SQLITE_ENABLED=true.

You can find a full list of configuration options in the configuration reference.

Build from source

If you don’t want to use docker, you can also build the application from source.

Note that no support is provided when running Koito built from source.

First, you need to install dependencies. Koito relies on make, yarn for building the client, and libvips-dev to process images.

sudo apt install libvips-dev make npm
sudo npm install --global yarn

If you aren’t installing on an Ubuntu or Debian based system, you can easily find ways to install make, npm, and yarn by googling, and you can find other ways to install libvips-dev on the libvips wiki.

Then, clone the repository and execute the build command using the included Makefile:

git clone https://github.com/gabehf/koito && cd koito
make build

When the build is finished, you can run the executable at the root of the directory.

./koito

Then, navigate your browser to localhost:4110 to enter your Koito instance.