Add new LXC: Paperless-AI

Author: MickLesk

ct/paperless-ai.sh

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: MickLesk (CanbiZ)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://github.com/clusterzx/paperless-ai
+
+# App Default Values
+APP="Paperless-AI"
+var_tags="ai;document"
+var_cpu="2"
+var_ram="2048"
+var_disk="5"
+var_os="debian"
+var_version="12"
+var_unprivileged="1"
+
+# App Output & Base Settings
+header_info "$APP"
+base_settings
+
+# Core
+variables
+color
+catch_errors
+
+function update_script() {
+  header_info
+  check_container_storage
+  check_container_resources
+  if [[ ! -d /opt/paperless-ai ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+  RELEASE=$(curl -s https://api.github.com/repos/clusterzx/paperless-ai/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+  if [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then
+  msg_info "Updating $APP"
+    msg_info "Stopping $APP"
+    systemctl stop paperless-ai
+    msg_ok "Stopped $APP"
+  
+    msg_info "Updating $APP to v${RELEASE}"
+    cd /opt
+    mv /opt/paperless-ai /opt/paperless-ai_bak
+    wget -q "https://github.com/clusterzx/paperless-ai/archive/refs/tags/v${RELEASE}.zip"
+    unzip -q v${RELEASE}.zip
+    mv paperless-ai-${RELEASE} /opt/paperless-ai
+	mkdir -p /opt/paperless-ai/data
+    cp -a /opt/paperless-ai_bak/data/. /opt/paperless-ai/data/
+    npm install &>/dev/null
+    echo "${RELEASE}" >/opt/${APP}_version.txt
+    msg_ok "Updated $APP to v${RELEASE}"
+
+    msg_info "Starting $APP"
+    systemctl start paperless-ai
+    msg_ok "Started $APP"
+
+    msg_info "Cleaning Up"
+    rm -rf /opt/v${RELEASE}.zip
+    rm -rf /opt/paperless-ai_bak
+    msg_ok "Cleanup Completed"
+    msg_ok "Update Successful"
+  else
+    msg_ok "No update required. ${APP} is already at v${RELEASE}"
+  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 "${TAB}${GATEWAY}${BGN}http://${IP}:3000${CL}"

install/paperless-ai-install.sh

@@ -0,0 +1,93 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: MickLesk (CanbiZ)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+
+source /dev/stdin <<< "$FUNCTIONS_FILE_PATH"
+color
+verb_ip6
+catch_errors
+setting_up_container
+network_check
+update_os
+
+msg_info "Installing Dependencies"
+$STD apt-get install -y \
+	curl \
+	sudo \
+	mc \
+	gpg
+msg_ok "Installed Dependencies"
+
+msg_info "Setting up Node.js Repository"
+mkdir -p /etc/apt/keyrings
+curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" >/etc/apt/sources.list.d/nodesource.list
+msg_ok "Set up Node.js Repository"
+
+msg_info "Installing Node.js"
+$STD apt-get update
+$STD apt-get install -y nodejs
+msg_ok "Installed Node.js"
+
+msg_info "Setup Paperless-AI"
+cd /opt
+RELEASE=$(curl -s https://api.github.com/repos/clusterzx/paperless-ai/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+wget -q "https://github.com/clusterzx/paperless-ai/archive/refs/tags/v${RELEASE}.zip"
+unzip -q v${RELEASE}.zip
+mv paperless-ai-${RELEASE} /opt/paperless-ai
+cd /opt/paperless-ai
+$STD npm install
+mkdir -p /opt/paperless-ai/data
+cat <<EOF >/opt/paperless-ai/data/.env
+PAPERLESS_API_URL=
+PAPERLESS_API_TOKEN=
+PAPERLESS_USERNAME=
+AI_PROVIDER=openai
+OPENAI_API_KEY=
+OPENAI_MODEL=gpt-4o-mini
+OLLAMA_API_URL=
+OLLAMA_MODEL=
+SCAN_INTERVAL=*/10 * * * *
+SYSTEM_PROMPT=""
+PROCESS_PREDEFINED_DOCUMENTS=no
+TAGS=
+ADD_AI_PROCESSED_TAG=no
+AI_PROCESSED_TAG_NAME=ki-gen
+USE_PROMPT_TAGS=no
+PROMPT_TAGS=
+USE_EXISTING_DATA=no
+API_KEY=
+CUSTOM_API_KEY=
+CUSTOM_BASE_URL=
+CUSTOM_MODEL=
+EOF
+echo "${RELEASE}" >"/opt/${APPLICATION}_version.txt"
+msg_ok "Setup Paperless-AI"
+
+msg_info "Creating Service"
+cat <<EOF >/etc/systemd/system/paperless-ai.service
+[Unit]
+Description=PaperlessAI Service
+After=network.target
+
+[Service]
+WorkingDirectory=/opt/paperless-ai
+ExecStart=/usr/bin/npm start
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now paperless-ai.service
+msg_ok "Created Service"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+rm -rf /opt/v${RELEASE}.zip
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"

json/paperless-ai.json

@@ -0,0 +1,34 @@
+{
+  "name": "PaperlessAI",
+  "slug": "paperless-ai",
+  "categories": [
+    20
+  ],
+  "date_created": "2025-02-06",
+  "type": "ct",
+  "updateable": true,
+  "privileged": false,
+  "interface_port": 3000,
+  "documentation": null,
+  "website": "https://github.com/clusterzx/paperless-ai",
+  "logo": "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/resources/logo/web/svg/square.svg",
+  "description": "An automated document analyzer for Paperless-ngx using OpenAI API, Ollama and all OpenAI API compatible Services to automatically analyze and tag your documents.It features: Automode, Manual Mode, Ollama and OpenAI, a Chat function to query your documents with AI, a modern and intuitive Webinterface.",
+  "install_methods": [
+    {
+      "type": "default",
+      "script": "ct/paperless-ai.sh",
+      "resources": {
+        "cpu": 2,
+        "ram": 2048,
+        "hdd": 5,
+        "os": "debian",
+        "version": "12"
+      }
+    }
+    ],
+    "default_credentials": {
+        "username": null,
+        "password": null
+    },
+    "notes": []
+}