Skip to content
Koito

Installation

Docker

Section titled “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
    depends_on:
      - db
    environment:
      - KOITO_DATABASE_URL=postgres://postgres:secret_password@db:5432/koitodb
      - KOITO_ALLOWED_HOSTS=koito.example.com,192.168.0.100:4110
    ports:
      - "4110:4110"
    volumes:
      - ./koito-data:/etc/koito
    restart: unless-stopped


  db:
    image: postgres:16
    container_name: psql
    restart: unless-stopped
    environment:
      POSTGRES_DB: koitodb
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: secret_password
    volumes:
      - ./db-data:/var/lib/postgresql/data

Be sure to replace secret_password with a random password of your choice, and set KOITO_ALLOWED_HOSTS to include the domain name or IP address + port you will be accessing Koito from when using either of the Docker methods described above.

Those are the two required environment variables. You can find a full list of configuration options in the configuration reference.

Build from source

Section titled “Build from source”

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

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

Terminal window
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:

Terminal window
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. You’ll also need to defined the required environment variables.

Terminal window
KOITO_DATABASE_URL=postgres://postgres:secret_password@postgres_ip:5432/koitodb \
KOITO_ALLOWED_HOSTS=koito.example.com,192.168.0.100:4110 \
./koito

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