Skip to content

Preparation

Go to the directory where you have checked out the project.

Prepare keys and Kitodo extensions

Before Docker Compose can be used, you must create directories to mount SSH key pairs for user authentication to OCR-D Controller (from Manager) and OCR-D Manager (from Kitodo.Production or Kitodo.Presentation etc).

Also, in case you have enabled Kitodo.Production as a module here, you must install some extensions into Kitodo.Production. For testing you probably need example data (e.g. users, authorities, workflows etc.) set up in its database, too.

The simplest way to get all that is by using the Makefile via the following commands:

make prepare          # generate all required files
make prepare-keys     # generate only SSH credentials (keys)
make prepare-data     # generate only Kitodo extensions (scripts)
make prepare-examples # generate only Kitodo database entries
make clean            # remove all generated files

Note: This may not meet your exact scenario entirely. To customize, have a look at the rules, or simulate running them via make -n prepare, or modify the results afterwards.

(For example, if you have set up the OCR-D Controller externally, you will have to manually append to its authorized_keys the file generated under ./ocrd/manager/.ssh/id_rsa.pub, or copy the existing private key into ./ocrd/manager/.ssh/id_rsa. Running the recipe will merely print instructions to do so.)

Alternatively, perform the following steps manually:

  • Create directories to host SSH key pair files:

    mkdir ./kitodo/.ssh/
mkdir ./ocrd/manager/.ssh/
mkdir ./ocrd/controller/.ssh/

  • Generate SSH key pairs in ./kitodo/.ssh/ and ./ocrd/manager/.ssh/.

  • After that, register the public keys on the other side, respectively:

    mv ./kitodo/.ssh/id_rsa.pub ./ocrd/manager/authorized_keys
mv ./ocrd/manager/id_rsa.pub ./ocrd/controller/authorized_keys

  • Copy contents of ./_resources/kitodo and ./_resources/kitodo-sample to the directory ./kitodo/overwrites to provide the examples and Kitodo.Production configuration files.

Installation of OCR-D models to OCR-D Controller

For practical workflows, you first have to install models for various processors on the OCR-D Controller.

Please follow the section Installing OCR-D Models of OCR-D Controller usage documentation.