Merge pull request #32 from compgeniuses/dev-1

Updates to Paperless NGX and its Dependecies

Author: compgeniuses

build-images.sh

@@ -14,8 +14,9 @@ images=()
 repobase="${REPOBASE:-ghcr.io/compgeniuses}"
 # Configure the image name
 reponame="paperlessngx"
-paperless_version="2.4.2"
-
+paperless_version="2.11.4"
+gotenberg_version="8.9.1"
+tika_version="3.0.0.0-BETA2-full"
 # Create a new empty container image
 container=$(buildah from scratch)
 
@@ -40,7 +41,7 @@ buildah config --entrypoint=/ \
     --label="org.nethserver.authorizations=traefik@node:routeadm" \
     --label="org.nethserver.tcp-ports-demand=1" \
     --label="org.nethserver.rootfull=0" \
-    --label="org.nethserver.images=docker.io/library/redis:7.2.3-bookworm docker.io/library/postgres:15.5-bookworm docker.io/paperlessngx/paperless-ngx:${paperless_version} ghcr.io/paperless-ngx/tika:2.9.0-full docker.io/gotenberg/gotenberg:7.10.2" \
+    --label="org.nethserver.images=docker.io/library/redis:7.2.3-bookworm docker.io/library/postgres:15.5-bookworm docker.io/paperlessngx/paperless-ngx:${paperless_version} docker.io/apache/tika:${tika_version} docker.io/gotenberg/gotenberg:${gotenberg_version}" \
     --label="org.nethserver.tcp-ports-demand=1" \
     "${container}"
 # Commit the image

imageroot/actions/configure-module/20configure

@@ -9,9 +9,22 @@ import json
 import sys
 # agent is a NethServer library which provides function to communicate with the agent
 import agent
-
+rdb = agent.redis_connect(use_replica=True)
+smtp_settings = agent.get_smarthost_settings(rdb)
 data = json.load(sys.stdin)
-
+# PAPERLESS_EMAIL_HOST=<str>
+# Defaults to 'localhost'.
+# PAPERLESS_EMAIL_PORT=<int>
+# Defaults to port 25.
+# PAPERLESS_EMAIL_HOST_USER=<str>
+# Defaults to ''.
+# PAPERLESS_EMAIL_FROM=<str>
+# Defaults to PAPERLESS_EMAIL_HOST_USER if not set.
+# PAPERLESS_EMAIL_HOST_PASSWORD=<str>
+# Defaults to ''.
+# PAPERLESS_EMAIL_USE_TLS=<bool>
+# Defaults to false.
+# PAPERLESS_EMAIL_USE_SSL=<bool>
 # Setup default values
 paperless_name = data.get("paperless_name","paperless-ngx")
 PAPERLESS_ADMIN_USER = data.get("PAPERLESS_ADMIN_USER","paperlessadmin")
@@ -21,52 +34,47 @@ PAPERLESS_TIME_ZONE = data.get("PAPERLESS_TIME_ZONE","America/Los_Angeles")
 PAPERLESS_OCR_LANGUAGE = data.get("PAPERLESS_OCR_LANGUAGE","eng")
 PAPERLESS_COOKIE_PREFIX = data.get("PAPERLESS_COOKIE_PREFIX","paperlessngx")
 PAPERLESS_FILENAME_FORMAT = data.get("PAPERLESS_FILENAME_FORMAT","{created_year}/{correspondent}/{doc_pk}-{title}")
-
+# Email Settings
+PAPERLESS_EMAIL_HOST = smtp_settings['host']
+PAPERLESS_EMAIL_PORT = smtp_settings['port']
+PAPERLESS_EMAIL_HOST_USER = smtp_settings['username']
+PAPERLESS_EMAIL_FROM = smtp_settings['username']
+PAPERLESS_EMAIL_HOST_PASSWORD = smtp_settings['password']
+PAPERLESS_EMAIL_USE_TLS = 'true' if smtp_settings['tls_verify'] else 'false'
+PAPERLESS_EMAIL_USE_SSL = 'false' if smtp_settings['tls_verify'] else 'true'
 # PAperless CSRF settings
 host = data.get("host", "")
 PAPERLESS_URL = "https://"+host
 
+paperless_config = {
+    "PAPERLESS_NGX_NAME": paperless_name,
+    "PAPERLESS_TIME_ZONE": PAPERLESS_TIME_ZONE,
+    "PAPERLESS_OCR_LANGUAGE": PAPERLESS_OCR_LANGUAGE,
+    "PAPERLESS_COOKIE_PREFIX": PAPERLESS_COOKIE_PREFIX,
+    "PAPERLESS_ADMIN_USER": PAPERLESS_ADMIN_USER,
+    "PAPERLESS_ADMIN_PASSWORD": PAPERLESS_ADMIN_PASSWORD,
+    "PAPERLESS_ADMIN_MAIL": PAPERLESS_ADMIN_MAIL,
+    "PAPERLESS_FILENAME_FORMAT": PAPERLESS_FILENAME_FORMAT,
+    "PAPERLESS_URL": PAPERLESS_URL,
+    "PAPERLESS_TIKA_ENABLED": "1",
+    "PAPERLESS_TIKA_GOTENBERG_ENDPOINT": "http://127.0.0.1:3000",
+    "PAPERLESS_TIKA_ENDPOINT": "http://127.0.0.1:9998",
+    "PAPERLESS_EMAIL_HOST": PAPERLESS_EMAIL_HOST,
+    "PAPERLESS_EMAIL_PORT": PAPERLESS_EMAIL_PORT,
+    "PAPERLESS_EMAIL_HOST_USER": PAPERLESS_EMAIL_HOST_USER,
+    "PAPERLESS_EMAIL_FROM": PAPERLESS_EMAIL_FROM,
+    "PAPERLESS_EMAIL_HOST_PASSWORD": PAPERLESS_EMAIL_HOST_PASSWORD,
+    "PAPERLESS_EMAIL_USE_TLS": PAPERLESS_EMAIL_USE_TLS,
+    "PAPERLESS_EMAIL_USE_SSL": PAPERLESS_EMAIL_USE_SSL,
 
-# Db Config
-
-POSTGRES_DB = data.get("POSTGRES_DB","paperless")
-POSTGRES_USER = data.get("POSTGRES_USER","paperless")
-POSTGRES_PASSWORD = data.get("POSTGRES_PASSWORD","p@perle$$")
-
-db_config = {
-    
-    "POSTGRES_ROOT_HOST": "localhost",
-    "POSTGRES_DATABASE": POSTGRES_DB,
-    "POSTGRES_USER": POSTGRES_USER,
-    "POSTGRES_PASSWORD": POSTGRES_PASSWORD,
-    
 }
-agent.write_envfile('database.env', db_config)
-
-# Talk with agent using file descriptor.
-
-# Setup configuration from user input.
-agent.set_env("PAPERLESS_NGX_NAME", paperless_name)
-agent.set_env("PAPERLESS_TIME_ZONE", PAPERLESS_TIME_ZONE)
-agent.set_env("PAPERLESS_OCR_LANGUAGE", PAPERLESS_OCR_LANGUAGE)
-agent.set_env("PAPERLESS_COOKIE_PREFIX", PAPERLESS_COOKIE_PREFIX)
-agent.set_env("PAPERLESS_ADMIN_USER", PAPERLESS_ADMIN_USER)
-agent.set_env("PAPERLESS_ADMIN_PASSWORD", PAPERLESS_ADMIN_PASSWORD)
-agent.set_env("PAPERLESS_ADMIN_MAIL", PAPERLESS_ADMIN_MAIL)
-agent.set_env("PAPERLESS_FILENAME_FORMAT", PAPERLESS_FILENAME_FORMAT)
 
-#paperless CSRF settings
-agent.set_env("PAPERLESS_URL", PAPERLESS_URL)
+agent.write_envfile('paperless-ngx.env', paperless_config)
 
-# Setup tika and gotenberg configuration from user input.
-agent.set_env("PAPERLESS_TIKA_ENABLED", "1")
-agent.set_env("PAPERLESS_TIKA_GOTENBERG_ENDPOINT", "http://127.0.0.1:3000")
-agent.set_env("PAPERLESS_TIKA_ENDPOINT", "http://127.0.0.1:9998")
 
 # Setup PHP with safe defaults
 agent.set_env("PHP_ENABLE_OPCACHE", "1")
 agent.set_env("PHP_MEMORY_LIMIT", "512M")
-# Configure Traefik to route "/paperlessngx" path requests to the paperlessngx service
 
 
 # Make sure everything is saved inside the environment file

imageroot/actions/create-module/20configure

@@ -17,9 +17,36 @@ data = json.load(sys.stdin)
 random_key = secrets.token_hex(16)
 PAPERLESS_SECRET_KEY = data.get("PAPERLESS_SECRET_KEY",random_key)
 
-# Talk with agent using file descriptor.
+# database Credentials
+def generate_random_password():
+    return secrets.token_urlsafe(16)
 
-agent.set_env("PAPERLESS_SECRET_KEY", PAPERLESS_SECRET_KEY)
+# Db Config
+
+POSTGRES_DB = data.get("POSTGRES_DB","paperless")
+POSTGRES_USER = data.get("POSTGRES_USER","paperless")
+POSTGRES_PASSWORD = generate_random_password()
+
+db_config = {
+    "POSTGRES_DATABASE": POSTGRES_DB,
+    "POSTGRES_USER": POSTGRES_USER,
+    "POSTGRES_PASSWORD": POSTGRES_PASSWORD,
+}
+agent.write_envfile('database.env', db_config)
+
+paperless_config = {
+    "PAPERLESS_DBENGINE": "postgresql",
+    "PAPERLESS_DBHOST": "paperless-pgsql",
+    "PAPERLESS_DBNAME": POSTGRES_DB,
+    "PAPERLESS_DBUSER": POSTGRES_USER,
+    "PAPERLESS_DBPASS": POSTGRES_PASSWORD,
+}
+agent.write_envfile('paperless-db.env', paperless_config)
+
+secret_key = {
+    "PAPERLESS_SECRET_KEY": PAPERLESS_SECRET_KEY,
+}
+agent.write_envfile('secret_key.env', secret_key)
 
 # Make sure everything is saved inside the environment file
 # just before starting systemd unit

imageroot/bin/discover-database

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3
+
+#
+# Copyright (C) 2023 Nethesis S.r.l.
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+import sys
+import agent
+import os
+
+# Connect the local Redis replica. This is necessary to consistently start
+database = "paperless-db.env"
+# check if it exists
+# set the default values
+
+if not os.path.exists(database):
+    POSTGRES_DB = "paperless"
+    POSTGRES_USER = "paperless"
+    POSTGRES_PASSWORD = "p@perle$$"
+    paperless_config = {
+        "PAPERLESS_DBENGINE": "postgresql",
+        "PAPERLESS_DBHOST": "paperless-pgsql",
+        "PAPERLESS_DBNAME": POSTGRES_DB,
+        "PAPERLESS_DBUSER": POSTGRES_USER,
+        "PAPERLESS_DBPASS": POSTGRES_PASSWORD,
+    }
+    agent.write_envfile("paperless-db.env", paperless_config)
+
+if not os.path.exists("secret_key.env"):
+    PAPERLESS_SECRET_KEY = os.getenv("PAPERLESS_SECRET_KEY", "")
+    secret_key = {
+        "PAPERLESS_SECRET_KEY": PAPERLESS_SECRET_KEY,
+    }
+    agent.write_envfile("secret_key.env", secret_key)

imageroot/etc/state-include.conf

@@ -4,4 +4,7 @@ volumes/paperlessngx-export
 volumes/paperlessngx-consume
 volumes/paperless-redis-data
 state/paperless.pg_dump
-state/database.env
+state/database.env
+state/paperless-ngx.env
+state/paperless-db.env
+state/secret_key.env

imageroot/systemd/user/paperless-server.service

@@ -19,6 +19,7 @@ WorkingDirectory=%S/state
 Restart=always
 ExecStartPre=/bin/rm -f %t/ns8-paperless-ngx.pid %t/ns8-paperless-ngx.ctr-id
 ExecStartPre=/usr/local/bin/runagent discover-smarthost
+ExecStartPre=/usr/local/bin/runagent discover-database
 ExecStart=/usr/bin/podman run \
     --detach \
     --conmon-pidfile=%t/ns8-paperless-ngx.pid \
@@ -27,12 +28,9 @@ ExecStart=/usr/bin/podman run \
     --cgroups=no-conmon \
     --replace --name=%N \
     --env-file=smarthost.env \
-    --env=PAPERLESS_* \
-    --env=PAPERLESS_DBENGINE=postgresql \
-    --env=PAPERLESS_DBHOST=127.0.0.1 \
-    --env=PAPERLESS_DBNAME=${POSTGRES_DATABASE} \
-    --env=PAPERLESS_DBUSER=${POSTGRES_USER} \
-    --env=PAPERLESS_DBPASS=${POSTGRES_PASSWORD} \
+    --env-file=%S/state/paperless-db.env \
+    --env-file=%S/state/secret_key.env \
+    --env-file=%S/state/paperless-ngx.env \
     --volume=paperlessngx-data:/usr/src/paperless/data \
     --volume=paperlessngx-media:/usr/src/paperless/media \
     --volume=paperlessngx-export:/usr/src/paperless/export \

ui/public/i18n/en/translation.json

@@ -33,7 +33,8 @@
     "enabled": "Enabled",
     "http_to_https": "http2https",
     "save": "Save",
-    "test_field": "Test field"
+    "test_field": "Test field",
+    "instance_configuration": "Configuring {instance} instance"
   },
   "about": {
     "title": "About"