diff --git a/.env b/.env index fd443201..b3e67e33 100644 --- a/.env +++ b/.env @@ -12,14 +12,15 @@ CONTROLLER_MODELS=${PWD}/ocrd/controller/models CONTROLLER_CONFIG=${PWD}/ocrd/controller/config CONTROLLER_WORKERS=1 -MONITOR_IMAGE=markusweigelt/ocrd_monitor:ocrd-stable-20220701 +MONITOR_IMAGE=markusweigelt/ocrd_monitor MONITOR_HOST=ocrd-monitor MONITOR_PORT_WEB=5000 MONITOR_PORT_GTK=8085 +MONITOR_PORT_LOG=8088 MONITOR_DATA=${PWD}/kitodo/data/metadata MANAGER_IMAGE=markusweigelt/ocrd_manager -MANAGER_IMAGE_TAG=ocrd-stable-20220701 +MANAGER_IMAGE_TAG=latest MANAGER_HOST=ocrd-manager MANAGER_ENV_UID=1001 MANAGER_ENV_GID=1001 diff --git a/Makefile b/Makefile index 7e616535..14fbd1ec 100644 --- a/Makefile +++ b/Makefile @@ -61,7 +61,7 @@ start: down: docker-compose down - + stop: docker-compose stop @@ -77,7 +77,7 @@ Targets: - build create directories, ssh key files - create build kitodo resources and images before starting containers using docker-compose up in detached mode - start run docker-compose up in detached mode - - down stop and remove docker-compose up + - down stop and remove docker-compose up - stop stops docker-compose up - config dump all the composed files - status list running containers diff --git a/README.md b/README.md index f8780a60..1b6fafe5 100644 --- a/README.md +++ b/README.md @@ -199,8 +199,9 @@ The following environment variables must be defined. | --- | --- | --- | | MONITOR_IMAGE | bertsky/ocrd_monitor | name of image | | MONITOR_HOST | ocrd-monitor | name of host | -| MONITOR_PORT_WEB | 5000 | host-side port to exposed Web server of container | -| MONITOR_PORT_GTK | 8085 | host-side port to exposed Broadwayd of container | +| MONITOR_PORT_WEB | 5000 | host-side port to exposed Web server | +| MONITOR_PORT_GTK | 8085 | host-side port to exposed Broadwayd (Gtk Web server) | +| MONITOR_PORT_LOG | 8088 | host-side port to exposed Dozzle (Docker log viewer) | | MONITOR_DATA | `./kitodo/data/metadata` | data volume to mount | (Currently, `MONITOR_DATA` should be the same as `MANAGER_DATA`.) @@ -240,9 +241,9 @@ the UID and GID of the Controller and Manager in our Makefile are taken from the Shell environment variables take precedence over `.env` file variables in Docker Compose. For example: - export CONTROLLER_ENV_UID=$(id -u) CONTROLLER_HOST=ocrserver + export CONTROLLER_ENV_UID=$(id -u) CONTROLLER_HOST=ocrserver CONTROLLER_SSH_PORT=8022 docker-compose up -d - + ### Install OCR-D models For practical workflows, you first have to install models into the OCR-D Controller. @@ -264,9 +265,9 @@ Open your browser and navigate to http://localhost:8080/kitodo after OCR-D and K Enter the user name `testadmin` and the password `test` in the login dialog. -> Note: If it is the first launch of Kitodo.Production, +> Note: If it is the first launch of Kitodo.Production, > then the `Indexing` tab of the system page is displayed, -> because indexing still needs to be done. +> because indexing still needs to be done. > To perform the indexing, click on the button `Create ElasticSearch mapping`. > After the mapping is created, click on the button `Start indexing` next to > the `Whole index` label. After a few seconds, the index is created and you @@ -293,6 +294,13 @@ is finished.) Watch `docker logs`, or browse to http://localhost:5000 to look under the hood with the Monitor. +### Monitor + +Provides a simplistic Web interface for +- browsing workspaces with [OCR-D Browser](https://github.com/hnesk/browse-ocrd) to inspect intermediate/final processing results +- getting statistics of running and terminated jobs +- reading logs + ## References - [OCR-D Controller](https://github.com/bertsky/ocrd_controller) diff --git a/_modules/ocrd_manager b/_modules/ocrd_manager index 64f27800..df0d9a7d 160000 --- a/_modules/ocrd_manager +++ b/_modules/ocrd_manager @@ -1 +1 @@ -Subproject commit 64f278003b4219bf97303d328fcf396b47ef0d8d +Subproject commit df0d9a7d6bbe9bd0e08371f15fad4947e4fcc189 diff --git a/docker-compose.yml b/docker-compose.yml index 7b4a82cc..2039d3aa 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -10,6 +10,11 @@ services: file: _modules/ocrd_manager/ocrd_monitor/docker-compose.yml service: ocrd-monitor + dozzle: + extends: + file: _modules/ocrd_manager/ocrd_monitor/docker-compose.yml + service: dozzle + # not defined here (to be replaced by docker-compose.managed.yml if needed): # service ocrd-controller @@ -19,3 +24,6 @@ services: # - kitodo-db # - kitodo-es # - kitodo-mq + +volumes: + shared: