From cbf4b9a78255eee4b6f4304d4c78b3f6031538eb Mon Sep 17 00:00:00 2001 From: maxnth Date: Mon, 9 Sep 2024 07:57:11 +0200 Subject: [PATCH 1/5] update setup guide --- docs/beta/setup.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/beta/setup.md b/docs/beta/setup.md index cde82daf..d86affd6 100644 --- a/docs/beta/setup.md +++ b/docs/beta/setup.md @@ -3,7 +3,7 @@ title: OCR4all 1.0 – Setup --- # {{ $frontmatter.title }} -If you want to try out the beta version of release 1.0 of OCR4all you can simply use the following Docker Compose file or download it [here](). +If you want to try out the beta version of release 1.0 of OCR4all you can simply use the following Docker Compose file or download it [here](https://github.com/OCR4all/ocr4all-docker/). The prerequisite for this is having both [Docker](https://docs.docker.com/get-started/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. @@ -11,8 +11,7 @@ A more in-depth installation guide will follow with the stable release of OCR4al ::: warning This will install an early beta version of OCR4all 1.0 which may still contain some bugs and many features (among others the base mode) are yet to come. - -A more detailed guide will follow shortly. +Therefore, we recommend that most users continue using the legacy version of OCR4all until the stable release of version 1.0! ::: ``` From 1135c7b8d14411131259453c0b7dd21debc12bf5 Mon Sep 17 00:00:00 2001 From: maxnth Date: Mon, 9 Sep 2024 07:58:57 +0200 Subject: [PATCH 2/5] update formatting --- docs/beta/setup.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/beta/setup.md b/docs/beta/setup.md index d86affd6..63a3e276 100644 --- a/docs/beta/setup.md +++ b/docs/beta/setup.md @@ -11,6 +11,7 @@ A more in-depth installation guide will follow with the stable release of OCR4al ::: warning This will install an early beta version of OCR4all 1.0 which may still contain some bugs and many features (among others the base mode) are yet to come. + Therefore, we recommend that most users continue using the legacy version of OCR4all until the stable release of version 1.0! ::: From 8e71b92737ba383efd9a4c6839a7f31e286c096b Mon Sep 17 00:00:00 2001 From: maxnth Date: Mon, 9 Sep 2024 08:04:09 +0200 Subject: [PATCH 3/5] add info section about default credentials --- docs/beta/setup.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/beta/setup.md b/docs/beta/setup.md index 63a3e276..67cd5481 100644 --- a/docs/beta/setup.md +++ b/docs/beta/setup.md @@ -71,3 +71,10 @@ services: - ${OCR4ALL_WORKSPACE:-~/ocr4all/docker/workspace}:/home/books image: uniwuezpd/larex:legacy ``` + +::: info +By default, the backend will automatically create an administrator account with the username `admin` and password `ocr4all`. +It is highly recommended to change the password immediately after setup! + +Documentation on the environment variables that can modify this behavior will be added soon. +::: From ce20302631d433e6b53ea2c94985ad85a7d7c972 Mon Sep 17 00:00:00 2001 From: maxnth Date: Tue, 10 Sep 2024 11:25:04 +0200 Subject: [PATCH 4/5] add background glow to hero image --- docs/index.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/index.md b/docs/index.md index 043f7b5f..4315c1d2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -36,3 +36,22 @@ features: - title: Easy cross-platform deployment details: Docker and a single command are all it takes to get OCR4all up and running, regardless of your operating system. --- + + From ebded80ec0d720f21d5c368f95cd6bb33b282e48 Mon Sep 17 00:00:00 2001 From: maxnth Date: Tue, 10 Sep 2024 13:34:43 +0200 Subject: [PATCH 5/5] update docker compose beta setup --- docs/beta/setup.md | 39 ++++++++++++++++++++------------------- docs/index.md | 19 ------------------- 2 files changed, 20 insertions(+), 38 deletions(-) diff --git a/docs/beta/setup.md b/docs/beta/setup.md index 67cd5481..64fa6410 100644 --- a/docs/beta/setup.md +++ b/docs/beta/setup.md @@ -24,12 +24,12 @@ services: environment: - SPRING_PROFILES_ACTIVE=${CALAMARI_PROFILES:-logging-debug,msa-api,docker} volumes: - - ${OCR4ALL_DATA:-~/ocr4all/docker/data}:/srv/ocr4all/data - - ${OCR4ALL_ASSEMBLE:-~/ocr4all/docker/assemble}:/srv/ocr4all/assemble - - ${OCR4ALL_WORKSPACE_PROJECT:-~/ocr4all/docker/workspace/projects}:/srv/ocr4all/projects + - ${SERVER_DATA:-~/ocr4all/docker/data}:/srv/ocr4all/data + - ${SERVER_ASSEMBLE:-~/ocr4all/docker/assemble}:/srv/ocr4all/assemble + - ${SERVER_WORKSPACE_PROJECT:-~/ocr4all/docker/workspace/projects}:/srv/ocr4all/projects ports: - "${CALAMARI_API_PORT:-127.0.0.1:9092}:8080" - image: uniwuezpd/ocr4all-msa-calamari:${OCR4ALL_MSA_CALAMARI_TAG:-latest} + image: uniwuezpd/ocr4all-msa-calamari:${CALAMARI_DOCKERHUB_TAG:-latest} msa-ocrd: hostname: msa-ocrd user: "${UID:-}" @@ -37,44 +37,45 @@ services: environment: - SPRING_PROFILES_ACTIVE=${OCRD_PROFILES:-logging-debug,msa-api,docker} volumes: - - ${OCR4ALL_WORKSPACE_PROJECT:-~/ocr4all/docker/workspace/projects}:/srv/ocr4all/projects - - ${OCR4ALL_RESOURCES_ORCD:-~/ocr4all/docker/opt/ocr-d/resources}:/usr/local/share/ocrd-resources + - ${SERVER_WORKSPACE_PROJECT:-~/ocr4all/docker/workspace/projects}:/srv/ocr4all/projects + - ${SERVER_RESOURCES_ORCD:-~/ocr4all/docker/opt/ocr-d/resources}:/usr/local/share/ocrd-resources ports: - "${OCRD_API_PORT:-127.0.0.1:9091}:8080" - image: uniwuezpd/ocr4all-msa-ocrd:${OCR4ALL_MSA_OCRD_TAG:-latest} + image: uniwuezpd/ocr4all-msa-ocrd:${OCRD_DOCKERHUB_TAG:-latest} server: user: "${UID:-}" restart: always environment: - - SPRING_PROFILES_ACTIVE=${OCR4ALL_PROFILES:-logging-debug,create_administrator,server,api,api-localhost,documentation,docker} + - SPRING_PROFILES_ACTIVE=${SERVER_PROFILES:-logging-debug,create_administrator,server,api,api-localhost,documentation,docker} + - OCR4ALL_APPLICATION_SECURITY_ADMINISTRATOR_LOGIN=${SERVER_ADMINISTRATOR_LOGIN:-admin} + - OCR4ALL_APPLICATION_SECURITY_ADMINISTRATOR_PASSWORD=${SERVER_ADMINISTRATOR_PASSWORD:-ocr4all} volumes: - - ${OCR4ALL_HOME:-~/ocr4all/docker}:/srv/ocr4all + - ${SERVER_HOME:-~/ocr4all/docker}:/srv/ocr4all ports: - - "${OCR4ALL_API_PORT:-9090}:8080" + - "${SERVER_API_PORT:-9090}:8080" depends_on: - msa-calamari - msa-ocrd - image: uniwuezpd/ocr4all-server:${OCR4ALL_SERVER_OCRD_TAG:-latest} + image: uniwuezpd/ocr4all-server:${SERVER_DOCKERHUB_TAG:-latest} webapp: ports: - - "${OCR4ALL_WEBAPP_PORT:-8080}:80" + - "${WEBAPP_PORT:-8080}:80" environment: - API_BASE_URL: ${OCR4ALL_WEBAPP_API_BASE_URL:-http://localhost:9090/api/v1.0} - LAREX_URL: ${OCR4ALL_WEBAPP_LAREX_URL:-http://localhost:8081/Larex/directLibrary} + API_BASE_URL: ${WEBAPP_API_BASE_URL:-http://localhost:9090/api/v1.0} + LAREX_URL: ${WEBAPP_LAREX_URL:-http://localhost:8081/Larex/directLibrary} restart: always - image: uniwuezpd/ocr4all-frontend:${OCR4ALL_WEBAPP_TAG:-latest} + image: uniwuezpd/ocr4all-frontend:${WEBAPP_DOCKERHUB_TAG:-latest} larex: ports: - "${LAREX_PORT:-8081}:8080" restart: always volumes: - - ${OCR4ALL_WORKSPACE:-~/ocr4all/docker/workspace}:/home/books + - ${SERVER_WORKSPACE:-~/ocr4all/docker/workspace}:/home/books image: uniwuezpd/larex:legacy ``` + ::: info By default, the backend will automatically create an administrator account with the username `admin` and password `ocr4all`. -It is highly recommended to change the password immediately after setup! - -Documentation on the environment variables that can modify this behavior will be added soon. +It is highly recommended to change the password immediately after setup or change the corresponding environment variables on setup. ::: diff --git a/docs/index.md b/docs/index.md index 4315c1d2..043f7b5f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -36,22 +36,3 @@ features: - title: Easy cross-platform deployment details: Docker and a single command are all it takes to get OCR4all up and running, regardless of your operating system. --- - -