.env

COMPOSE_PROJECT_NAME=ocrd_kitodo

# Manager SSH server
MANAGER_BASE_VERSION=latest # tag of ocrd/core from stage version
MANAGER_IMAGE=ghcr.io/slub/ocrd_manager:latest # name and tag of image
MANAGER_HOST=ocrd-manager # name/address of server (for Kitodo)
MANAGER_PORT_SSH=9022 # host-side port to exposed SSH server (for external Kitodo)
MANAGER_PORT_WEB=4004 # port of web endpoint
MANAGER_ENV_UID=1001 # user id of SSH user (`id -u` when using `make`)
MANAGER_ENV_GID=1001 # group id of SSH user (`id -g` when using `make`)
MANAGER_ENV_UMASK=0002 # ssh user specific permission mask
MANAGER_KEYS=${PWD}/ocrd/manager/.ssh/authorized_keys # file path with public SSH keys of users allowed to log in
MANAGER_KEY=${PWD}/ocrd/manager/.ssh/id_rsa # file path with private SSH key of internal `ocrd` user (should match one of `CONTROLLER_KEYS`)
MANAGER_DATA=${PWD}/kitodo/data/metadata # persistent data volume to mount
MANAGER_WORKFLOWS=${PWD}/_modules/ocrd_manager/workflows # persistent volume for workflows

# Monitor Web server
MONITOR_IMAGE=ghcr.io/slub/ocrd_monitor:latest # name and tag of image
MONITOR_HOST=ocrd-monitor # name/address of server
MONITOR_PORT_WEB=5000 # host-side port to exposed Web server
MONITOR_PORT_LOG=8088 # host-side port to exposed Dozzle (Docker log viewer)
MONITOR_PORT_DBM=8082 # host-side port to exposed OCR-D Database Management (Mongo Express)
MONITOR_DB_ROOT_USER=root # root user of OCR-D database
MONITOR_DB_ROOT_PASSWORD=root_password # root password of OCR-D database

# Controller SSH server (with-ocrd-controller)
CONTROLLER_BASE_VERSION=2024-03-08 # tag of ocrd/all from stage version
CONTROLLER_IMAGE=ghcr.io/slub/ocrd_controller:latest # name and tag of image
CONTROLLER_HOST=ocrd-controller # name/address of server (for Manager/Monitor)
CONTROLLER_PORT_SSH=22 # SSH port (for Manager/Monitor)
CONTROLLER_ENV_UID=1001 # user id of SSH user (`id -u` when using `make`)
CONTROLLER_ENV_GID=1001 # group id of SSH user (`id -g` when using `make`)
CONTROLLER_ENV_UMASK=0002 # SSH user specific permission mask
CONTROLLER_KEYS=${PWD}/ocrd/controller/.ssh/authorized_keys # file path with public SSH keys of users allowed to log in
CONTROLLER_DATA=${PWD}/ocrd/controller/data # persistent data volume to mount
CONTROLLER_MODELS=${PWD}/ocrd/controller/models # path to persistent models (in `ocrd-resources/`)
CONTROLLER_CONFIG=${PWD}/ocrd/controller/config # path to persistent config (in `ocrd/resources.yml`)
CONTROLLER_WORKERS=1 # number of workers for processing

# Application Kitodo.Production (with-kitodo-production)
APP_IMAGE=ghcr.io/slub/ocrd_kitodo/kitodo_production_ocrd:latest # name and tag of image
APP_BUILD_CONTEXT=${PWD}/_modules/kitodo-production-docker/ # directory of Dockerfile
APP_BUILDER_GIT_REF=master # branch "ocrd-main" of git repository (cause using `git` as `BUILDER_TYPE`)
APP_BUILDER_GIT_REPOSITORY=kitodo/kitodo-production # repository of `BUILDER_GIT_COMMIT` (cause using `git` as `BUILDER_TYPE`)
APP_DATA=${PWD}/kitodo/data # persistent volume of application data to mount, e.g. config and modules
APP_KEY=${PWD}/kitodo/.ssh/id_rsa # file path with private SSH key of `ocrd` user (should match one of `MANAGER_KEYS`)
APP_PORT=8080 # host-side port of Kitodo.Production

# Database (with-kitodo-production)
DB_IMAGE=mysql:8.0.32 # name and tag of image
DB_HOST=kitodo-db # name/address of database (for Kitodo)
DB_PORT=3306 # host-side port to exposed database
DB_ROOT_USER=root
DB_ROOT_PASSWORD=1234 # root user password
DB_NAME=kitodo # name of database used by Kitodo.Production
DB_USER=kitodo # username to access database
DB_USER_PASSWORD=kitodo # password used by username to access database

# Elastic Search (with-kitodo-production)
ES_IMAGE=elasticsearch:7.17.8 # name and tag of image
ES_HOST=kitodo-es # name/address of server (for Kitodo)
ES_REST_PORT=9200 # host-side port to REST API
ES_NODE_PORT=9300 # host-side port to inter-node protocol

# Active MQ (with-kitodo-production)
MQ_IMAGE=ghcr.io/slub/kitodo-production-activemq:latest # name and tag of image
MQ_HOST=kitodo-mq # name/address of server (for Kitodo/Manager)
MQ_PORT=61616 # host-side port to exposed TCP Transport