From 33a7cc06bffc7c9c45b22a37a8c85bf37986470e Mon Sep 17 00:00:00 2001 From: tremor021 Date: Thu, 11 Sep 2025 20:28:32 +0200 Subject: [PATCH] Add Joplin Server script --- ct/joplin-server.sh | 81 +++++++++++++++++++++++++++ install/joplin-server-install.sh | 95 ++++++++++++++++++++++++++++++++ 2 files changed, 176 insertions(+) create mode 100644 ct/joplin-server.sh create mode 100644 install/joplin-server-install.sh diff --git a/ct/joplin-server.sh b/ct/joplin-server.sh new file mode 100644 index 00000000..922b0e04 --- /dev/null +++ b/ct/joplin-server.sh @@ -0,0 +1,81 @@ +#!/usr/bin/env bash +source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/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:-15}" +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 + + RELEASE=$(curl -fsSL https://api.github.com/repos/laurent22/joplin/releases/latest | jq '.tag_name' | sed 's/^"v//;s/"$//') + if check_for_gh_release "joplin-server" "laurent22/joplin"; then + msg_info "Stopping Services" + systemctl stop joplin-server + msg_ok "Stopped Services" + + INSTALL_DIR="/opt/autocaliweb" + export VIRTUAL_ENV="${INSTALL_DIR}/venv" + $STD tar -cf ~/autocaliweb_bkp.tar "$INSTALL_DIR"/{metadata_change_logs,dirs.json,.env,scripts/ingest_watcher.sh,scripts/auto_zipper_wrapper.sh,scripts/metadata_change_detector_wrapper.sh} + fetch_and_deploy_gh_release "autocaliweb" "gelbphoenix/autocaliweb" "tarball" "latest" "/opt/autocaliweb" + msg_info "Updating ${APP}" + cd "$INSTALL_DIR" + if [[ ! -d "$VIRTUAL_ENV" ]]; then + $STD uv venv "$VIRTUAL_ENV" + fi + $STD uv sync --all-extras --active + cd "$INSTALL_DIR"/koreader/plugins + PLUGIN_DIGEST="$(find acwsync.koplugin -type f -name "*.lua" -o -name "*.json" | sort | xargs sha256sum | sha256sum | cut -d' ' -f1)" + echo "Plugin files digest: $PLUGIN_DIGEST" >acwsync.koplugin/${PLUGIN_DIGEST}.digest + echo "Build date: $(date)" >>acwsync.koplugin/${PLUGIN_DIGEST}.digest + echo "Files included:" >>acwsync.koplugin/${PLUGIN_DIGEST}.digest + $STD zip -r koplugin.zip acwsync.koplugin/ + cp -r koplugin.zip "$INSTALL_DIR"/cps/static + mkdir -p "$INSTALL_DIR"/metadata_temp + $STD tar -xf ~/autocaliweb_bkp.tar --directory / + KEPUB_VERSION="$(/usr/bin/kepubify --version)" + CALIBRE_RELEASE="$(curl -s https://api.github.com/repos/kovidgoyal/calibre/releases/latest | grep -o '"tag_name": "[^"]*' | cut -d'"' -f4)" + echo "${KEPUB_VERSION#v}" >"$INSTALL_DIR"/KEPUBIFY_RELEASE + echo "${CALIBRE_RELEASE#v}" >/"$INSTALL_DIR"/CALIBRE_RELEASE + sed 's/^/v/' ~/.autocaliweb >"$INSTALL_DIR"/ACW_RELEASE + chown -R acw:acw "$INSTALL_DIR" + rm ~/autocaliweb_bkp.tar + msg_ok "Updated $APP" + + msg_info "Starting Services" + systemctl start autocaliweb metadata-change-detector acw-ingest-service acw-auto-zipper + 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}:8083${CL}" diff --git a/install/joplin-server-install.sh b/install/joplin-server-install.sh new file mode 100644 index 00000000..77d2c297 --- /dev/null +++ b/install/joplin-server-install.sh @@ -0,0 +1,95 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: Slaviša Arežina (tremor021) +# License: MIT | https://github.com/community-scripts/ProxmoxVED/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="16" setup_postgresql +NODE_VERSION=22 NODE_MODULE="yarn@latest,npm@latest,pm2@latest" setup_nodejs +mkdir -p /opt/pm2 +export PM2_HOME=/opt/pm2 +pm2 install pm2-logrotate +pm2 set pm2-logrotate:max_size 100MB +pm2 set pm2-logrotate:retain 5 +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 "Setup Joplin Server (Patience)" +LOCAL_IP=$(hostname -I | awk '{print $1}') +cd /opt/joplin-server +$STD yarn config set --home enableTelemetry 0 +export BUILD_SEQUENCIAL=1 +$STD yarn install --inline-builds + +cat </opt/joplin-server/.env +APP_BASE_URL=http://$LOCAL_IP:22300 +APP_PORT=22300 +DB_CLIENT=pg +POSTGRES_PASSWORD=$DB_PASS +POSTGRES_DATABASE=joplin +POSTGRES_USER=joplin +POSTGRES_PORT=5432 +POSTGRES_HOST=localhost +EOF +msg_ok "Setup Joplin Server" + +msg_info "Setup Service" +cat </etc/systemd/system/joplin-server.service +[Unit] +Description=Joplin Server Service +After=network.target + +[Service] +Type=simple +Directory=/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"