User:Victor Grousset - tuxayo/Setup Koha development environment with koha-testing-docker

From Koha Wiki
Jump to navigation Jump to search

Isn't this redundant with the README?

The aim is to have

  • a quick start guide with some ready to paste commands
  • a cheat sheet for some things
  • a way of doing some things that are more convenient in my case
  • complete some non-obvious stuff for beginners
  • have some choices already made
  • have a reference to other resources non-obvious to find (if any)


cheat sheet:

Install procedure


OS: Solus Linux

  • docker
  • docker compose
  • package importlib_metadata from the repos


Build and run the containers

ku-md10 ; kd
# in that case we use Debian 10 and MariaDB from it's repos

Meanwhile, read the README, because this document is more of a quickstart + cheat sheet:

Go to the web interface

Get the container IP address

docker exec -it koha_koha_1 ip addr show dev eth0 | grep inet

go to the URLs

log in

Default example data:

  • user: koha
  • password: koha

Run the tests

Go into the container


Switch to the right directory

cd koha

Run the actual tests

# one test
time prove t/db_dependent/Search.t

# all the tests
time prove -r t/ xt/ -j $(nproc) --rules='seq=t/db_dependent/**.t'

Use Elasticsearch

Go to the database

Via it's container

Directly run the mysql client and login with default dev credentials

docker exec -it koha_db_1 mysql -u koha_kohadev --password=password -D koha_kohadev

Via Koha's container

mysql -h db -u root -ppassword

Stop the container

Ctrl-c in the terminal with the containers where started.

Or, run `kd` in another terminal.


In the directory of your Koha clone. Create shared/custom.sql and it's content will be executed on very KTD startup.



Koha's source code

In your koha source code directory

git checkout master ; git pull
# or some equivalent way, it depends on your preferences.


In the koha-testing-docker directory

# stop the containers

# update the code of koha-testing-docker, which contains the files that set up the containers running Koha
cd YOUR_KOHA_TESTING_DOCKER_DIRECTORY # this is not Koha's code, this directory contains `docker-compose.yml`
git pull

# update the images, mainly for the Perl libraries that Koha uses
docker-compose pull

# cleanup of the old images
# if you update often, you will accumulate maybe more than 10GiB per month of storage
# WARNING: if you use docker for something else than Koha you can't just clean using the following "nuke" method.
# You will likely loose data.
# In this case you will have to know more about docker and you use case. And do manual cleanup work. It's not covered here.
# When using docker only for Koha:
docker system prune --volumes # prune aggressively
# agree to the cleanup and you should see a lot of gigabytes freed!

Now you can start your up to date Koha environment :D

Cleaning up unused stuff

Intensive use (multiple startups per day, multiple OSes and Koha versions) and updates can cause old docker images and volumes to consume more that 75GiB per month of storage in the host system.