From d0a1f305c7cbfa8d1c521cd9e79901b16d766a22 Mon Sep 17 00:00:00 2001
From: "push-app-to-main[bot]"
 <203845782+push-app-to-main[bot]@users.noreply.github.com>
Date: Wed, 24 Sep 2025 14:28:02 +0200
Subject: [PATCH] Add Script: Joplin Server (#7879)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: push-app-to-main[bot] <203845782+push-app-to-main[bot]@users.noreply.github.com>
Co-authored-by: Slaviša Arežina <58952836+tremor021@users.noreply.github.com>
Co-authored-by: Tobias <96661824+CrazyWolf13@users.noreply.github.com>
---
 ct/headers/joplin-server                |  6 ++
 ct/joplin-server.sh                     | 62 ++++++++++++++++
 frontend/public/json/joplin-server.json | 40 ++++++++++
 install/joplin-server-install.sh        | 98 +++++++++++++++++++++++++
 4 files changed, 206 insertions(+)
 create mode 100644 ct/headers/joplin-server
 create mode 100644 ct/joplin-server.sh
 create mode 100644 frontend/public/json/joplin-server.json
 create mode 100644 install/joplin-server-install.sh

diff --git a/ct/headers/joplin-server b/ct/headers/joplin-server
new file mode 100644
index 000000000..3d72492c3
--- /dev/null
+++ b/ct/headers/joplin-server
@@ -0,0 +1,6 @@
+       _             ___                                           
+      (_)___  ____  / (_)___        ________  ______   _____  _____
+     / / __ \/ __ \/ / / __ \______/ ___/ _ \/ ___/ | / / _ \/ ___/
+    / / /_/ / /_/ / / / / / /_____(__  )  __/ /   | |/ /  __/ /    
+ __/ /\____/ .___/_/_/_/ /_/     /____/\___/_/    |___/\___/_/     
+/___/     /_/                                                      
diff --git a/ct/joplin-server.sh b/ct/joplin-server.sh
new file mode 100644
index 000000000..7b1d87027
--- /dev/null
+++ b/ct/joplin-server.sh
@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: Slaviša Arežina (tremor021)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://joplinapp.org/
+
+APP="Joplin-Server"
+var_tags="${var_tags:-notes}"
+var_cpu="${var_cpu:-2}"
+var_ram="${var_ram:-4096}"
+var_disk="${var_disk:-20}"
+var_os="${var_os:-debian}"
+var_version="${var_version:-12}"
+var_unprivileged="${var_unprivileged:-1}"
+
+header_info "$APP"
+variables
+color
+catch_errors
+
+function update_script() {
+  header_info
+  check_container_storage
+  check_container_resources
+  if [[ ! -d /opt/joplin-server ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+
+  if check_for_gh_release "joplin-server" "laurent22/joplin"; then
+    msg_info "Stopping Services"
+    systemctl stop joplin-server
+    msg_ok "Stopped Services"
+
+    fetch_and_deploy_gh_release "joplin-server" "laurent22/joplin" "tarball" "latest"
+
+    msg_info "Updating ${APP}"
+    cd /opt/joplin-server
+    sed -i "/onenote-converter/d" packages/lib/package.json
+    $STD yarn config set --home enableTelemetry 0
+    export BUILD_SEQUENCIAL=1
+    $STD yarn install --inline-builds
+    msg_ok "Updated ${APP}"
+
+    msg_info "Starting Services"
+    systemctl start joplin-server
+    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 "${TAB}${GATEWAY}${BGN}http://${IP}:22300${CL}"
diff --git a/frontend/public/json/joplin-server.json b/frontend/public/json/joplin-server.json
new file mode 100644
index 000000000..49db64487
--- /dev/null
+++ b/frontend/public/json/joplin-server.json
@@ -0,0 +1,40 @@
+{
+  "name": "Joplin Server",
+  "slug": "joplin-server",
+  "categories": [
+    12
+  ],
+  "date_created": "2025-09-12",
+  "type": "ct",
+  "updateable": true,
+  "privileged": false,
+  "interface_port": 22300,
+  "documentation": "https://joplinapp.org/help/",
+  "config_path": "/opt/joplin-server/.env",
+  "website": "https://joplinapp.org/",
+  "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/joplin.webp",
+  "description": "Joplin - the privacy-focused note taking app with sync capabilities for Windows, macOS, Linux, Android and iOS.",
+  "install_methods": [
+    {
+      "type": "default",
+      "script": "ct/joplin-server.sh",
+      "resources": {
+        "cpu": 2,
+        "ram": 4096,
+        "hdd": 20,
+        "os": "Debian",
+        "version": "12"
+      }
+    }
+  ],
+  "default_credentials": {
+    "username": "admin@localhost",
+    "password": "admin"
+  },
+  "notes": [
+    {
+      "text": "Application can take some time to build, depending on your host speed. Please be patient.",
+      "type": "info"
+    }
+  ]
+}
diff --git a/install/joplin-server-install.sh b/install/joplin-server-install.sh
new file mode 100644
index 000000000..1abe51095
--- /dev/null
+++ b/install/joplin-server-install.sh
@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: Slaviša Arežina (tremor021)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://joplinapp.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-get install -y \
+  git \
+  rsync
+msg_ok "Installed Dependencies"
+
+PG_VERSION="17" setup_postgresql
+NODE_VERSION=22 NODE_MODULE="yarn@latest,npm@latest,pm2@latest" setup_nodejs
+mkdir -p /opt/pm2
+export PM2_HOME=/opt/pm2
+$STD pm2 install pm2-logrotate
+$STD pm2 set pm2-logrotate:max_size 100MB
+$STD pm2 set pm2-logrotate:retain 5
+$STD pm2 set pm2-logrotate:compress tr
+
+msg_info "Setting up PostgreSQL Database"
+DB_NAME=joplin
+DB_USER=joplin
+DB_PASS="$(openssl rand -base64 18 | cut -c1-13)"
+$STD sudo -u postgres psql -c "CREATE ROLE $DB_USER WITH LOGIN PASSWORD '$DB_PASS';"
+$STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME WITH OWNER $DB_USER ENCODING 'UTF8' TEMPLATE template0;"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET client_encoding TO 'utf8';"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET default_transaction_isolation TO 'read committed';"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET timezone TO 'UTC'"
+{
+  echo "Joplin-Credentials"
+  echo "Joplin Database User: $DB_USER"
+  echo "Joplin Database Password: $DB_PASS"
+  echo "Joplin Database Name: $DB_NAME"
+} >>~/joplin.creds
+msg_ok "Set up PostgreSQL Database"
+
+fetch_and_deploy_gh_release "joplin-server" "laurent22/joplin" "tarball" "latest"
+
+msg_info "Setting up Joplin Server (Patience)"
+LOCAL_IP=$(hostname -I | awk '{print $1}')
+cd /opt/joplin-server
+sed -i "/onenote-converter/d" packages/lib/package.json
+$STD yarn config set --home enableTelemetry 0
+export BUILD_SEQUENCIAL=1
+$STD yarn install --inline-builds
+
+cat <<EOF >/opt/joplin-server/.env
+PM2_HOME=/opt/pm2
+NODE_ENV=production
+APP_BASE_URL=http://$LOCAL_IP:22300
+APP_PORT=22300
+DB_CLIENT=pg
+POSTGRES_PASSWORD=$DB_PASS
+POSTGRES_DATABASE=$DB_NAME
+POSTGRES_USER=$DB_USER
+POSTGRES_PORT=5432
+POSTGRES_HOST=localhost
+EOF
+msg_ok "Setup Joplin Server"
+
+msg_info "Setting up Service"
+cat <<EOF >/etc/systemd/system/joplin-server.service
+[Unit]
+Description=Joplin Server Service
+After=network.target
+
+[Service]
+Type=simple
+WorkingDirectory=/opt/joplin-server/packages/server
+EnvironmentFile=/opt/joplin-server/.env
+ExecStart=/usr/bin/yarn start-prod
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now joplin-server
+msg_ok "Service Setup"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"