Setup

Prerequisites and Installation

We recommend setup with docker-compose and Makefile for simplest possible use.

Tools needed:

Docker (installed automatically on Linux running make provision (for osx or windows you need to install manually)
Docker-compose (optional, but highly recommended. On Linux, same as above)
Make (optional, recommended for simple build/setup/development commands)

Using Makefile

On Linux you would simply do make provision to setup system with docker-compose, docker and pulling docker images and setting up containers and data volumes. For overriding any variables, simply put them in a file: docker-compose/.env

make help will give overview of make targets

make provision will pull / build the necessary images and start containers.

Using Docker-compose

All relevant files are in folder docker-compose

Basic setup with NO customizations would require:

cd docker-compose source docker-compose.env && docker-compose -f common.yml -f build.yml up -d

docker-compose.env (base environment variables) KOHA_BUILD, KOHA_VERSION, KOHA_IMAGE_TAG, GITREF

Using Docker only

A plain startup with NO customisations:

docker run -d --name koha_docker \
  --cap-add=DAC_READ_SEARCH --cap-add=SYS_NICE --cap-add=MKNOD \
	-p 6001:6001 -p 8080:8080 -p 8081:8081 \
	-e KOHA_INSTANCE=name \
	-e KOHA_ADMINUSER=admin \
	-e KOHA_ADMINPASS=secret \
	-t digibib/koha

Please note that a lot of features will not work out of the box. (Email, SMS).

Environment and Configuration

Using the Koha Docker image