From aab9d42322c84820da08d7ee18126828585831a4 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, 1 Feb 2026 00:16:01 +0100 Subject: [PATCH] shelfmark (#11371) * Add shelfmark (ct) * Apply suggestions from code review * Apply suggestion from @vhsdream * Update shelfmark.sh * Update shelfmark.json * Update shelfmark-install.sh * Update install/shelfmark-install.sh * Update install/shelfmark-install.sh --------- Co-authored-by: push-app-to-main[bot] <203845782+push-app-to-main[bot]@users.noreply.github.com> Co-authored-by: Chris Co-authored-by: Tobias <96661824+CrazyWolf13@users.noreply.github.com> --- ct/shelfmark.sh | 90 ++++++++++++ frontend/public/json/shelfmark.json | 40 ++++++ install/shelfmark-install.sh | 216 ++++++++++++++++++++++++++++ 3 files changed, 346 insertions(+) create mode 100644 ct/shelfmark.sh create mode 100644 frontend/public/json/shelfmark.json create mode 100644 install/shelfmark-install.sh diff --git a/ct/shelfmark.sh b/ct/shelfmark.sh new file mode 100644 index 000000000..0bec17a25 --- /dev/null +++ b/ct/shelfmark.sh @@ -0,0 +1,90 @@ +#!/usr/bin/env bash +source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func) +# Copyright (c) 2021-2026 community-scripts ORG +# Author: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/calibrain/shelfmark + +APP="shelfmark" +var_tags="${var_tags:-ebooks}" +var_cpu="${var_cpu:-2}" +var_ram="${var_ram:-2048}" +var_disk="${var_disk:-8}" +var_os="${var_os:-debian}" +var_version="${var_version:-13}" +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/shelfmark ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + NODE_VERSION="22" setup_nodejs + PYTHON_VERSION="3.12" setup_uv + + if check_for_gh_release "shelfmark" "calibrain/shelfmark"; then + msg_info "Stopping Service(s)" + systemctl stop shelfmark + [[ -f /etc/systemd/system/chromium.service ]] && systemctl stop chromium + msg_ok "Stopped Service(s)" + + [[ -f /etc/systemd/system/flaresolverr.service ]] && if check_for_gh_release "flaresolverr" "Flaresolverr/Flaresolverr"; then + msg_info "Stopping FlareSolverr service" + systemctl stop flaresolverr + msg_ok "Stopped FlareSolverr service" + + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "flaresolverr" "FlareSolverr/FlareSolverr" "prebuild" "latest" "/opt/flaresolverr" "flaresolverr_linux_x64.tar.gz" + + msg_info "Starting FlareSolverr Service" + systemctl start flaresolverr + msg_ok "Started FlareSolverr Service" + msg_ok "Updated FlareSolverr" + fi + + cp /opt/shelfmark/start.sh /opt/start.sh.bak + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "shelfmark" "calibrain/shelfmark" "tarball" "latest" "/opt/shelfmark" + RELEASE_VERSION=$(cat "$HOME/.shelfmark") + + msg_info "Updating Shelfmark" + sed -i "s/^RELEASE_VERSION=.*/RELEASE_VERSION=$RELEASE_VERSION/" /etc/shelfmark/.env + cd /opt/shelfmark/src/frontend + $STD npm ci + $STD npm run build + mv /opt/shelfmark/src/frontend/dist /opt/shelfmark/frontend-dist + cd /opt/shelfmark + $STD uv venv -c ./venv + $STD source ./venv/bin/activate + $STD uv pip install -r ./requirements-base.txt + if [[ $(sed -n '/_BYPASS=/s/[^=]*=//p' /etc/shelfmark/.env) == "true" ]] && [[ $(sed -n '/BYPASSER=/s/[^=]*=//p' /etc/shelfmark/.env) == "false" ]]; then + $STD uv pip install -r ./requirements-shelfmark.txt + fi + mv /opt/start.sh.bak /opt/shelfmark/start.sh + msg_ok "Updated Shelfmark" + + msg_info "Starting Service(s)" + systemctl start shelfmark + [[ -f /etc/systemd/system/chromium.service ]] && systemctl start chromium + msg_ok "Started Service(s)" + 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}:8084${CL}" diff --git a/frontend/public/json/shelfmark.json b/frontend/public/json/shelfmark.json new file mode 100644 index 000000000..955ae8a2c --- /dev/null +++ b/frontend/public/json/shelfmark.json @@ -0,0 +1,40 @@ +{ + "name": "Shelfmark", + "slug": "shelfmark", + "categories": [ + 13 + ], + "date_created": "2026-01-30", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 8084, + "documentation": "https://github.com/calibrain/shelfmark/tree/main/docs", + "website": "https://github.com/calibrain/shelfmark", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/shelfmark.webp", + "config_path": "/etc/shelfmark", + "description": "Shelfmark is a unified web interface for searching and aggregating books and audiobook downloads from multiple sources - all in one place.", + "install_methods": [ + { + "type": "default", + "script": "ct/shelfmark.sh", + "resources": { + "cpu": 2, + "ram": 2048, + "hdd": 8, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [ + { + "text": "The configuration at `/etc/shelfmark/.env` is for bootstrapping the initial install. Customize the configuration via the Shelfmark UI.", + "type": "info" + } + ] +} diff --git a/install/shelfmark-install.sh b/install/shelfmark-install.sh new file mode 100644 index 000000000..d29a8463c --- /dev/null +++ b/install/shelfmark-install.sh @@ -0,0 +1,216 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/calibrain/shelfmark + +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 \ + unrar-free +ln -sf /usr/bin/unrar-free /usr/bin/unrar +msg_ok "Installed Dependencies" + +mkdir -p /etc/shelfmark +cat </etc/shelfmark/.env +DOCKERMODE=false +CONFIG_DIR=/etc/shelfmark +TMP_DIR=/tmp/shelfmark +ENABLE_LOGGING=true +FLASK_HOST=0.0.0.0 +FLASK_PORT=8084 +# SESSION_COOKIES_SECURE=true +# CWA_DB_PATH= +USE_CF_BYPASS=true +USING_EXTERNAL_BYPASSER=false +# EXT_BYPASSER_URL= +# EXT_BYPASSER_PATH=/v1 +EOF + +echo "" +echo "" +echo -e "${BL}Shelfmark Deployment Type${CL}" +echo "─────────────────────────────────────────" +echo "Please choose your deployment type:" +echo "" +echo " 1) Use Shelfmark's internal captcha bypasser (default)" +echo " 2) Install FlareSolverr in this LXC" +echo " 3) Use an existing Flaresolverr/Byparr LXC" +echo " 4) Disable captcha bypassing altogether (not recommended)" +echo "" + +read -r -p "${TAB3}Select deployment type [1]: " DEPLOYMENT_TYPE +DEPLOYMENT_TYPE="${DEPLOYMENT_TYPE:-1}" + +case "$DEPLOYMENT_TYPE" in +1) + msg_ok "Using Shelfmark's internal captcha bypasser" + ;; +2) + msg_ok "Proceeding with FlareSolverr installation" + ;; +3) + echo "" + echo -e "${BL}Use an existing FlareSolverr/Byparr LXC${CL}" + echo "─────────────────────────────────────────" + echo "Enter the URL/IP address with port of your Flaresolverr/Byparr instance" + echo "Example: http://flaresoverr.homelab.lan:8191 or" + echo "http://192.168.10.99:8191" + echo "" + read -r -p "FlareSolverr/Byparr URL: " BYPASSER_URL + + if [[ -z "$BYPASSER_URL" ]]; then + msg_warn "No Flaresolverr/Byparr URL provided. Falling back to Shelfmark's internal bypasser." + else + BYPASSER_URL="${BYPASSER_URL%/}" + msg_ok "FlareSolverr/Byparr URL: ${BYPASSER_URL}" + fi + ;; +4) + msg_warn "Disabling captcha bypass. This may cause the majority of searches and downloads to fail." + ;; +*) + msg_warn "Invalid selection. Reverting to default (internal bypasser)!" + ;; +esac + +if [[ "$DEPLOYMENT_TYPE" == "2" ]]; then + fetch_and_deploy_gh_release "flaresolverr" "FlareSolverr/FlareSolverr" "prebuild" "latest" "/opt/flaresolverr" "flaresolverr_linux_x64.tar.gz" + msg_info "Installing FlareSolverr (patience)" + $STD apt install -y xvfb + setup_deb822_repo \ + "google-chrome" \ + "https://dl.google.com/linux/linux_signing_key.pub" \ + "https://dl.google.com/linux/chrome/deb/" \ + "stable" + $STD apt install -y google-chrome-stable + rm /etc/apt/sources.list.d/google-chrome.list + sed -i -e '/BYPASSER=/s/false/true/' \ + -e 's/^# EXT_/EXT_/' \ + -e "s|_URL=.*|_URL=http://localhost:8191|" /etc/shelfmark/.env + msg_ok "Installed FlareSolverr" +elif [[ "$DEPLOYMENT_TYPE" == "3" ]]; then + sed -i -e '/BYPASSER=/s/false/true/' \ + -e 's/^# EXT_/EXT_/' \ + -e "s|_URL=.*|_URL=${BYPASSER_URL}|" /etc/shelfmark/.env +elif [[ "$DEPLOYMENT_TYPE" == "4" ]]; then + sed -i '/_BYPASS=/s/true/false/' /etc/shelfmark/.env +else + DEPLOYMENT_TYPE="1" + CHROME_VERSION=$(curl -fsSL https://raw.githubusercontent.com/calibrain/shelfmark/refs/heads/main/Dockerfile | sed -n '/chromium=/s/[^=]*=//p' | awk '{print $1}') + msg_info "Installing internal bypasser dependencies" + $STD apt install -y --no-install-recommends \ + xvfb \ + ffmpeg \ + chromium-common=${CHROME_VERSION} \ + chromium=${CHROME_VERSION} \ + chromium-driver=${CHROME_VERSION} \ + python3-tk + msg_ok "Installed internal bypasser dependencies" +fi + +NODE_VERSION="22" setup_nodejs +PYTHON_VERSION="3.12" setup_uv + +fetch_and_deploy_gh_release "shelfmark" "calibrain/shelfmark" "tarball" "latest" "/opt/shelfmark" +RELEASE_VERSION=$(cat "$HOME/.shelfmark") + +msg_info "Building Shelfmark frontend" +cd /opt/shelfmark/src/frontend +echo "RELEASE_VERSION=${RELEASE_VERSION}" >>/etc/shelfmark/.env +$STD npm ci +$STD npm run build +mv /opt/shelfmark/src/frontend/dist /opt/shelfmark/frontend-dist +msg_ok "Built Shelfmark frontend" + +msg_info "Configuring Shelfmark" +cd /opt/shelfmark +$STD uv venv ./venv +$STD source ./venv/bin/activate +$STD uv pip install -r ./requirements-base.txt +[[ "$DEPLOYMENT_TYPE" == "1" ]] && $STD uv pip install -r ./requirements-shelfmark.txt +mkdir -p {/var/log/shelfmark,/tmp/shelfmark} +msg_ok "Configured Shelfmark" + +msg_info "Creating Services and start script" +cat </etc/systemd/system/shelfmark.service +[Unit] +Description=Shelfmark server +After=network.target + +[Service] +Type=simple +WorkingDirectory=/opt/shelfmark +EnvironmentFile=/etc/shelfmark/.env +ExecStart=/usr/bin/bash /opt/shelfmark/start.sh +Restart=always +RestartSec=10 +KillMode=mixed + +[Install] +WantedBy=multi-user.target +EOF + +if [[ "$DEPLOYMENT_TYPE" == "1" ]]; then + cat </etc/systemd/system/chromium.service +[Unit] +Description=Chromium Headless Browser +After=network.target + +[Service] +User=root +ExecStart=/usr/bin/chromium --headless --no-sandbox --disable-gpu --disable-dev-shm-usage --remote-debugging-address=127.0.0.1 --remote-debugging-port=9222 --hide-scrollbars +Restart=always + +[Install] +WantedBy=multi-user.target +EOF + systemctl enable -q --now chromium +fi +if [[ "$DEPLOYMENT_TYPE" == "2" ]]; then + cat </etc/systemd/system/flaresolverr.service +[Unit] +Description=FlareSolverr +After=network.target +[Service] +SyslogIdentifier=flaresolverr +Restart=always +RestartSec=5 +Type=simple +Environment="LOG_LEVEL=info" +Environment="CAPTCHA_SOLVER=none" +WorkingDirectory=/opt/flaresolverr +ExecStart=/opt/flaresolverr/flaresolverr +TimeoutStopSec=30 +[Install] +WantedBy=multi-user.target +EOF + systemctl enable -q --now flaresolverr +fi + +cat </opt/shelfmark/start.sh +#!/usr/bin/env bash + +source /opt/shelfmark/venv/bin/activate +set -a +source /etc/shelfmark/.env +set +a + +gunicorn --worker-class geventwebsocket.gunicorn.workers.GeventWebSocketWorker --workers 1 -t 300 -b 0.0.0.0:8084 shelfmark.main:app +EOF +chmod +x /opt/shelfmark/start.sh + +systemctl enable -q --now shelfmark +msg_ok "Created Services and start script" + +motd_ssh +customize +cleanup_lxc