Kitodo Dev (Docker)

About

This repository contains a docker-compose configuration and devcontainer.json to develop Kitodo Production inside a Docker container.

Prerequisites

You need to have Docker and Docker Compose installed on your system.
Make sure that Docker has access to enough RAM to run all the services (>= 4GB).

Usage instructions (terminal)

Use these instructions if you don't want to develop with Visual Studio Code.

If you haven't already clone the Kitodo Production repository to your local machine.
Clone this repository to your local machine.
Inside this repository's main folder create a .env file with the following content:
```
KITODO_PATH=path/to/kitodo-production
```
Open a terminal inside this repository's main folder and run
```
docker-compose up
```
Your Kitodo Production repository will be mounted to /root/kitodo-production inside the container. It will be built immediately and deployed to the tomcat webserver. You can access it at localhost/kitodo.

Open a terminal inside the Kitodo container with:

docker exec -it -w /root/kitodo-production CONTAINERNAME /bin/bash

Now you can build Kitodo from inside the container.

Usage instructions (Visual Studio Code)

If you haven't already clone the Kitodo Production repository to your local machine.
Clone this repository to your local machine.
Inside this repository's main folder create a .env file with the following content:
```
KITODO_PATH=path/to/kitodo-production
```
Install the Remote Containers Extension for Visual Studio Code.
Open this repository with VS Code.
Click the blue icon in the lower left corner and select Reopen in Container.

The docker-compose configuration will build and deploy Kitodo on startup. Unfortunately, VS Code does not show this progress in the terminal. Wait until the address localhost/kitodo is available before starting your work. This can take up to 10 minutes.

Deploying Kitodo manually

When attached to the container, run the following command from inside the kitodo-production directory:

bash ../deploy.sh