From a4a4b40eafa9b72924dd83fa89bb7386f4d952e8 Mon Sep 17 00:00:00 2001 From: "push-app-to-main[bot]" <203845782+push-app-to-main[bot]@users.noreply.github.com> Date: Sun, 26 Jul 2026 11:14:10 +0000 Subject: [PATCH] Add docspell (ct) --- ct/docspell.sh | 61 ++++++++++++++++++++ ct/headers/docspell | 6 ++ install/docspell-install.sh | 108 ++++++++++++++++++++++++++++++++++++ 3 files changed, 175 insertions(+) create mode 100644 ct/docspell.sh create mode 100644 ct/headers/docspell create mode 100644 install/docspell-install.sh diff --git a/ct/docspell.sh b/ct/docspell.sh new file mode 100644 index 000000000..6d493e9dd --- /dev/null +++ b/ct/docspell.sh @@ -0,0 +1,61 @@ +#!/usr/bin/env bash +source "$(dirname "${BASH_SOURCE[0]}")/../misc/build.func" 2>/dev/null || source <(curl -fsSL "${COMMUNITY_SCRIPTS_URL:-https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main}/misc/build.func") +# Copyright (c) 2021-2026 community-scripts ORG +# Author: MickLesk (CanbiZ) +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://docspell.org/ + +APP="Docspell" +var_tags="${var_tags:-documents;ocr;paperless;productivity}" +var_cpu="${var_cpu:-4}" +var_ram="${var_ram:-4096}" +var_disk="${var_disk:-16}" +var_os="${var_os:-debian}" +var_version="${var_version:-13}" +var_arm64="${var_arm64:-yes}" +var_unprivileged="${var_unprivileged:-1}" + +header_info "$APP" +variables +color +catch_errors + +function update_script() { + header_info + check_container_storage + check_container_resources + + if [[ ! -f /etc/docspell-restserver/docspell-server.conf ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + if check_for_gh_release "docspell-joex" "eikek/docspell"; then + msg_info "Stopping Services" + systemctl stop docspell-joex docspell-restserver + msg_ok "Stopped Services" + + create_backup /etc/docspell-joex/docspell-joex.conf \ + /etc/docspell-restserver/docspell-server.conf + + DPKG_FORCE_CONFOLD=1 fetch_and_deploy_gh_release "docspell-joex" "eikek/docspell" "binary" "latest" "/opt/docspell" "docspell-joex_*_all.deb" + DPKG_FORCE_CONFOLD=1 fetch_and_deploy_gh_release "docspell-restserver" "eikek/docspell" "binary" "latest" "/opt/docspell" "docspell-restserver_*_all.deb" + + restore_backup + + msg_info "Starting Services" + systemctl start docspell-restserver docspell-joex + msg_ok "Started Services" + msg_ok "Updated successfully!" + fi + exit +} + +start +build_container +description + +msg_ok "Completed Successfully!\n" +echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}" +echo -e "${INFO}${YW}Access it using the following URL:${CL}" +echo -e "${GATEWAY}${BGN}http://${IP}:7880${CL}" diff --git a/ct/headers/docspell b/ct/headers/docspell new file mode 100644 index 000000000..51277d47b --- /dev/null +++ b/ct/headers/docspell @@ -0,0 +1,6 @@ + ____ ____ + / __ \____ ______________ ___ / / / + / / / / __ \/ ___/ ___/ __ \/ _ \/ / / + / /_/ / /_/ / /__(__ ) /_/ / __/ / / +/_____/\____/\___/____/ .___/\___/_/_/ + /_/ diff --git a/install/docspell-install.sh b/install/docspell-install.sh new file mode 100644 index 000000000..122bf160d --- /dev/null +++ b/install/docspell-install.sh @@ -0,0 +1,108 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: MickLesk (CanbiZ) +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://docspell.org/ + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +msg_info "Installing Dependencies" +$STD apt install -y \ + ocrmypdf \ + tesseract-ocr \ + tesseract-ocr-deu \ + tesseract-ocr-eng \ + unpaper \ + weasyprint \ + libreoffice-core \ + ghostscript \ + libreoffice-writer \ + libreoffice-calc \ + python3-pip \ + python3-uno \ + python3-venv + +python3 -m venv \ + --system-site-packages \ + /opt/unoserver + +$STD /opt/unoserver/bin/pip install --upgrade pip +$STD /opt/unoserver/bin/pip install unoserver +msg_ok "Installed Dependencies" + +JAVA_VERSION="21" setup_java +PG_VERSION="17" setup_postgresql +PG_DB_NAME="docspell" PG_DB_USER="docspell" setup_postgresql_db + +fetch_and_deploy_gh_release "docspell-joex" "eikek/docspell" "binary" "latest" "/opt/docspell" "docspell-joex_*_all.deb" +fetch_and_deploy_gh_release "docspell-restserver" "eikek/docspell" "binary" "latest" "/opt/docspell" "docspell-restserver_*_all.deb" + +msg_info "Configuring Docspell" +DOCSPELL_SECRET=$(openssl rand -hex 32) +DOCSPELL_ADMIN_SECRET=$(openssl rand -hex 32) +cat </etc/docspell-restserver/docspell-server.conf +docspell.server { + app-id = "rest1" + base-url = "http://${LOCAL_IP}:7880" + internal-url = "http://127.0.0.1:7880" + bind { + address = "0.0.0.0" + port = 7880 + } + auth.server-secret = "hex:${DOCSPELL_SECRET}" + admin-endpoint.secret = "${DOCSPELL_ADMIN_SECRET}" + full-text-search { + enabled = true + backend = "postgresql" + postgresql.use-default-connection = true + } + backend { + jdbc { + url = "jdbc:postgresql://127.0.0.1:5432/${PG_DB_NAME}" + user = "${PG_DB_USER}" + password = "${PG_DB_PASS}" + } + signup.mode = "open" + } +} +EOF +cat </etc/docspell-joex/docspell-joex.conf +docspell.joex { + app-id = "joex1" + base-url = "http://127.0.0.1:7878" + bind { + address = "127.0.0.1" + port = 7878 + } + jdbc { + url = "jdbc:postgresql://127.0.0.1:5432/${PG_DB_NAME}" + user = "${PG_DB_USER}" + password = "${PG_DB_PASS}" + } + full-text-search { + enabled = true + backend = "postgresql" + postgresql.use-default-connection = true + } + scheduler.pool-size = 1 + text-analysis.nlp.mode = "basic" +} +EOF +chown root:docspell /etc/docspell-joex/docspell-joex.conf /etc/docspell-restserver/docspell-server.conf +chmod 640 /etc/docspell-joex/docspell-joex.conf /etc/docspell-restserver/docspell-server.conf +msg_ok "Configured Docspell" + +msg_info "Creating Services" +systemctl enable -q --now docspell-restserver docspell-joex +msg_ok "Created Services" + +motd_ssh +customize +cleanup_lxc