From 028b6fcd8945be7d531a1b1e1972fe8d871d7b33 Mon Sep 17 00:00:00 2001 From: <> Date: Tue, 12 Mar 2024 14:26:56 +0000 Subject: [PATCH] Deployed a63a8c8 with MkDocs version: 1.5.3 --- .nojekyll | 0 404.html | 778 ++ _generated/env-app-table/index.html | 843 +++ _generated/env-controller-table/index.html | 868 +++ _generated/env-db-table/index.html | 848 +++ _generated/env-es-table/index.html | 828 ++ _generated/env-manager-table/index.html | 868 +++ _generated/env-monitor-table/index.html | 843 +++ _generated/env-mq-table/index.html | 823 ++ assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.c8d2eff1.min.js | 29 + assets/javascripts/bundle.c8d2eff1.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.b8dbb3d2.min.js | 42 + .../workers/search.b8dbb3d2.min.js.map | 7 + assets/stylesheets/main.7e359304.min.css | 1 + assets/stylesheets/main.7e359304.min.css.map | 1 + assets/stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + getting-started/index.html | 946 +++ index.html | 961 +++ search/search_index.json | 1 + setup/configure-external/index.html | 1254 +++ setup/configure-modules/index.html | 1402 ++++ setup/enable-disable-modules/index.html | 915 +++ setup/preparation/index.html | 945 +++ setup/prerequisites/index.html | 907 +++ setup/running/index.html | 1037 +++ sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes usage/demo/index.html | 987 +++ usage/kitodo-production/index.html | 902 +++ usage/ocrd-controller/index.html | 897 +++ usage/ocrd-manager/index.html | 957 +++ usage/overview/index.html | 884 +++ 68 files changed, 26987 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 _generated/env-app-table/index.html create mode 100644 _generated/env-controller-table/index.html create mode 100644 _generated/env-db-table/index.html create mode 100644 _generated/env-es-table/index.html create mode 100644 _generated/env-manager-table/index.html create mode 100644 _generated/env-monitor-table/index.html create mode 100644 _generated/env-mq-table/index.html create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.c8d2eff1.min.js create mode 100644 assets/javascripts/bundle.c8d2eff1.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js.map create mode 100644 assets/stylesheets/main.7e359304.min.css create mode 100644 assets/stylesheets/main.7e359304.min.css.map create mode 100644 assets/stylesheets/palette.06af60db.min.css create mode 100644 assets/stylesheets/palette.06af60db.min.css.map create mode 100644 getting-started/index.html create mode 100644 index.html create mode 100644 search/search_index.json create mode 100644 setup/configure-external/index.html create mode 100644 setup/configure-modules/index.html create mode 100644 setup/enable-disable-modules/index.html create mode 100644 setup/preparation/index.html create mode 100644 setup/prerequisites/index.html create mode 100644 setup/running/index.html create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 usage/demo/index.html create mode 100644 usage/kitodo-production/index.html create mode 100644 usage/ocrd-controller/index.html create mode 100644 usage/ocrd-manager/index.html create mode 100644 usage/overview/index.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..2434279e --- /dev/null +++ b/404.html @@ -0,0 +1,778 @@ + + + +
+ + + + + + + + + + + + + + +Name | +Default | +Description | +
---|---|---|
APP_IMAGE | +ghcr.io/slub/ocrd_kitodo/kitodo_production_ocrd:latest | +name and tag of image | +
APP_BUILD_CONTEXT | +./_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 | +./kitodo/data |
+persistent volume of application data to mount, e.g. config and modules | +
APP_KEY | +./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 | +
Name | +Default | +Description | +
---|---|---|
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 | +./ocrd/controller/.ssh/authorized_keys |
+file path with public SSH keys of users allowed to log in | +
CONTROLLER_DATA | +./ocrd/controller/data |
+persistent data volume to mount | +
CONTROLLER_MODELS | +./ocrd/controller/models |
+path to persistent models (in ocrd-resources/ ) |
+
CONTROLLER_CONFIG | +./ocrd/controller/config |
+path to persistent config (in ocrd/resources.yml ) |
+
CONTROLLER_WORKERS | +1 | +number of workers for processing | +
Name | +Default | +Description | +
---|---|---|
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 | +
Name | +Default | +Description | +
---|---|---|
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 | +
Name | +Default | +Description | +
---|---|---|
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 | +./ocrd/manager/.ssh/authorized_keys |
+file path with public SSH keys of users allowed to log in | +
MANAGER_KEY | +./ocrd/manager/.ssh/id_rsa |
+file path with private SSH key of internal ocrd user (should match one of CONTROLLER_KEYS ) |
+
MANAGER_DATA | +./kitodo/data/metadata |
+persistent data volume to mount | +
MANAGER_WORKFLOWS | +./_modules/ocrd_manager/workflows |
+persistent volume for workflows | +
Name | +Default | +Description | +
---|---|---|
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 | +
Name | +Default | +Description | +
---|---|---|
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 | +
{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var Va=/["'&<>]/;qn.exports=za;function za(e){var t=""+e,r=Va.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i