From 1ca99781ff2c38aefb4d494eeb45829fac5dc4a3 Mon Sep 17 00:00:00 2001 From: vhsdream <67816022+vhsdream@users.noreply.github.com> Date: Mon, 2 Dec 2024 03:09:22 -0500 Subject: [PATCH] New Script: Hoarder LXC (#567) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add Hoarder script * Point build.func to correct repo * I hate testing these scripts * no comment * Quiesce systemctl enable output; add move DB to hoarder_data * add timeout to hoarder-workers * Restore attribution * fix sourcefix source URLs; quiesce migration post-install * Update hoarder-install.sh to move commands to separate lines Also made similar changes in some other areas. * Delete install/bazarr-install.sh * Delete ct/bazarr.sh * Update msg_info Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> * Update msg_ok Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> * Update msg_info Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> * Update ct/hoarder.sh Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> * Remove bazarr.sh and bazarr-install.sh changes from PR * Add Json for Website * Apply suggestions from code review Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> * Update ct/hoarder.sh Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> * Update hoarder.sh * remove unnecessary dependencies; clean up worker & web install; remove zip after cleanup * Apply suggestions from code review Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> * Update hoarder.sh (&>/dev/null) &>/dev/null * Fix broken DB migration, other small changes * Update resources in hoarder.json * Update install/hoarder-install.sh with commented refs for AI tagging Co-authored-by: Mohamed Bassem --------- Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com> Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com> Co-authored-by: Mohamed Bassem --- ct/hoarder.sh | 106 ++++++++++++++++++++++ install/hoarder-install.sh | 180 +++++++++++++++++++++++++++++++++++++ json/hoarder.json | 34 +++++++ 3 files changed, 320 insertions(+) create mode 100644 ct/hoarder.sh create mode 100644 install/hoarder-install.sh create mode 100644 json/hoarder.json diff --git a/ct/hoarder.sh b/ct/hoarder.sh new file mode 100644 index 00000000..b28a52a8 --- /dev/null +++ b/ct/hoarder.sh @@ -0,0 +1,106 @@ +#!/usr/bin/env bash +source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func) +# Copyright (c) 2021-2024 tteck +# Author: MickLesk (Canbiz) & vhsdream +# License: MIT +# https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE + +function header_info { +clear +cat <<"EOF" + __ __ __ + / / / /___ ____ __________/ /__ _____ + / /_/ / __ \/ __ `/ ___/ __ / _ \/ ___/ + / __ / /_/ / /_/ / / / /_/ / __/ / +/_/ /_/\____/\__,_/_/ \__,_/\___/_/ + +EOF +} +header_info +echo -e "Loading..." +APP="Hoarder" +var_disk="8" +var_cpu="2" +var_ram="4096" +var_os="debian" +var_version="12" +variables +color +catch_errors + +function default_settings() { + CT_TYPE="1" + PW="" + CT_ID=$NEXTID + HN=$NSAPP + DISK_SIZE="$var_disk" + CORE_COUNT="$var_cpu" + RAM_SIZE="$var_ram" + BRG="vmbr0" + NET="dhcp" + GATE="" + APT_CACHER="" + APT_CACHER_IP="" + DISABLEIP6="no" + MTU="" + SD="" + NS="" + MAC="" + VLAN="" + SSH="no" + VERB="no" + echo_default +} + +function update_script() { +header_info +check_container_storage +check_container_resources +if [[ ! -d /opt/hoarder ]]; then msg_error "No ${APP} Installation Found!"; exit; fi +RELEASE=$(curl -s https://api.github.com/repos/hoarder-app/hoarder/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }') +PREV_RELEASE=$(cat /opt/${APP}_version.txt) +if [[ ! -f /opt/${APP}_version.txt ]] || [[ "${RELEASE}" != "${PREV_RELEASE}" ]]; then + msg_info "Stopping Services" + systemctl stop hoarder-web hoarder-workers hoarder-browser + msg_ok "Stopped Services" + msg_info "Updating ${APP} to v${RELEASE}" + cd /opt + mv /opt/hoarder/.env /opt/.env + rm -rf /opt/hoarder + wget -q "https://github.com/hoarder-app/hoarder/archive/refs/tags/v${RELEASE}.zip" + unzip -q v${RELEASE}.zip + mv hoarder-${RELEASE} /opt/hoarder + cd /opt/hoarder/apps/web + pnpm install --frozen-lockfile &>/dev/null + pnpm exec next build --experimental-build-mode compile &>/dev/null + cp -r /opt/hoarder/apps/web/.next/standalone/apps/web/server.js /opt/hoarder/apps/web + cd /opt/hoarder/apps/workers + pnpm install --frozen-lockfile &>/dev/null + export DATA_DIR=/opt/hoarder_data + cd /opt/hoarder/packages/db + pnpm migrate &>/dev/null + mv /opt/.env /opt/hoarder/.env + sed -i "s/SERVER_VERSION=${PREV_RELEASE}/SERVER_VERSION=${RELEASE}/" /opt/hoarder/.env + msg_ok "Updated ${APP} to v${RELEASE}" + + msg_info "Starting Services" + systemctl start hoarder-browser hoarder-workers hoarder-web + msg_ok "Started Services" + msg_info "Cleaning up" + rm -R /opt/v${RELEASE}.zip + echo "${RELEASE}" >/opt/${APP}_version.txt + msg_ok "Cleaned" + msg_ok "Updated Successfully" +else + msg_ok "No update required. ${APP} is already at ${RELEASE}." +fi +exit +} + +start +build_container +description + +msg_ok "Completed Successfully!\n" +echo -e "${APP} Setup should be reachable by going to the following URL. + ${BL}http://${IP}:3000${CL} \n" diff --git a/install/hoarder-install.sh b/install/hoarder-install.sh new file mode 100644 index 00000000..92eed2de --- /dev/null +++ b/install/hoarder-install.sh @@ -0,0 +1,180 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2024 tteck +# Author: MickLesk (Canbiz) & vhsdream +# 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 \ + g++ \ + build-essential \ + curl \ + git \ + sudo \ + gnupg \ + ca-certificates \ + chromium \ + mc +msg_ok "Installed Dependencies" + +msg_info "Installing Additional Tools" +wget -q https://github.com/Y2Z/monolith/releases/latest/download/monolith-gnu-linux-x86_64 -O /usr/bin/monolith +chmod +x /usr/bin/monolith +wget -q https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux -O /usr/bin/yt-dlp +chmod +x /usr/bin/yt-dlp +msg_ok "Installed Additional Tools" + +msg_info "Installing Meilisearch" +cd /tmp +wget -q https://github.com/meilisearch/meilisearch/releases/latest/download/meilisearch.deb +$STD dpkg -i meilisearch.deb +wget -q https://raw.githubusercontent.com/meilisearch/meilisearch/latest/config.toml -O /etc/meilisearch.toml +MASTER_KEY=$(openssl rand -base64 12) +sed -i \ + -e 's|^env =.*|env = "production"|' \ + -e "s|^# master_key =.*|master_key = \"$MASTER_KEY\"|" \ + -e 's|^db_path =.*|db_path = "/var/lib/meilisearch/data"|' \ + -e 's|^dump_dir =.*|dump_dir = "/var/lib/meilisearch/dumps"|' \ + -e 's|^snapshot_dir =.*|snapshot_dir = "/var/lib/meilisearch/snapshots"|' \ + -e 's|^# no_analytics = true|no_analytics = true|' \ + /etc/meilisearch.toml +msg_ok "Installed Meilisearch" + +msg_info "Installing Node.js" +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 +$STD apt-get update +$STD apt-get install -y nodejs +msg_ok "Installed Node.js" + +msg_info "Installing Hoarder" +cd /opt +RELEASE=$(curl -s https://api.github.com/repos/hoarder-app/hoarder/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }') +wget -q "https://github.com/hoarder-app/hoarder/archive/refs/tags/v${RELEASE}.zip" +unzip -q v${RELEASE}.zip +mv hoarder-${RELEASE} /opt/hoarder +cd /opt/hoarder +corepack enable +export PUPPETEER_SKIP_DOWNLOAD="true" +export NEXT_TELEMETRY_DISABLED=1 +export CI="true" +cd /opt/hoarder/apps/web +$STD pnpm install --frozen-lockfile +$STD pnpm exec next build --experimental-build-mode compile +cp -r /opt/hoarder/apps/web/.next/standalone/apps/web/server.js /opt/hoarder/apps/web +cd /opt/hoarder/apps/workers +$STD pnpm install --frozen-lockfile + +export DATA_DIR=/opt/hoarder_data +HOARDER_SECRET=$(openssl rand -base64 36 | cut -c1-24) +cat </opt/hoarder/.env +SERVER_VERSION=$RELEASE +NEXTAUTH_SECRET="$HOARDER_SECRET" +NEXTAUTH_URL="http://localhost:3000" +DATA_DIR="$DATA_DIR" +MEILI_ADDR="http://127.0.0.1:7700" +MEILI_MASTER_KEY="$MASTER_KEY" +BROWSER_WEB_URL="http://127.0.0.1:9222" + +# If you're planning to use OpenAI for tagging. Uncomment the following line: +# OPENAI_API_KEY="" + +# If you're planning to use ollama for tagging, uncomment the following lines: +# OLLAMA_BASE_URL="" + +# You can change the models used by uncommenting the following lines, and changing them according to your needs: +# INFERENCE_TEXT_MODEL="gpt-4o-mini" +# INFERENCE_IMAGE_MODEL="gpt-4o-mini" +EOF +echo "${RELEASE}" >"/opt/${APPLICATION}_version.txt" +msg_ok "Installed Hoarder" + +msg_info "Running Database Migration" +mkdir -p ${DATA_DIR} +cd /opt/hoarder/packages/db +$STD pnpm migrate +msg_ok "Database Migration Completed" + +msg_info "Creating Services" +cat </etc/systemd/system/meilisearch.service +[Unit] +Description=Meilisearch +After=network.target + +[Service] +ExecStart=/usr/bin/meilisearch --config-file-path /etc/meilisearch.toml +Restart=always + +[Install] +WantedBy=multi-user.target +EOF + +cat </etc/systemd/system/hoarder-web.service +[Unit] +Description=Hoarder Web +Wants=network.target hoarder-workers.service +After=network.target hoarder-workers.service + +[Service] +ExecStart=pnpm start +WorkingDirectory=/opt/hoarder/apps/web +EnvironmentFile=/opt/hoarder/.env +Restart=always + +[Install] +WantedBy=multi-user.target +EOF + +cat </etc/systemd/system/hoarder-browser.service +[Unit] +Description=Hoarder 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 + +cat </etc/systemd/system/hoarder-workers.service +[Unit] +Description=Hoarder Workers +Wants=network.target hoarder-browser.service meilisearch.service +After=network.target hoarder-browser.service meilisearch.service + +[Service] +ExecStart=pnpm start:prod +WorkingDirectory=/opt/hoarder/apps/workers +EnvironmentFile=/opt/hoarder/.env +Restart=always +TimeoutStopSec=5 + +[Install] +WantedBy=multi-user.target +EOF + +systemctl -q enable --now meilisearch.service hoarder-browser.service hoarder-workers.service hoarder-web.service +msg_ok "Created Services" + +motd_ssh +customize + +msg_info "Cleaning up" +rm -rf /tmp/meilisearch.deb +rm -f /opt/v${RELEASE}.zip +$STD apt-get autoremove -y +$STD apt-get autoclean -y +msg_ok "Cleaned" diff --git a/json/hoarder.json b/json/hoarder.json new file mode 100644 index 00000000..87c7e556 --- /dev/null +++ b/json/hoarder.json @@ -0,0 +1,34 @@ +{ + "name": "Hoarder", + "slug": "hoarder", + "categories": [ + 14 + ], + "date_created": "2024-11-28", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 3000, + "documentation": "https://docs.hoarder.app/", + "website": "https://hoarder.app/", + "logo": "https://raw.githubusercontent.com/hoarder-app/hoarder/refs/heads/main/screenshots/logo.png", + "description": "Hoarder is an AI-powered bookmarking tool that helps you save and organize your digital content. It automatically tags your links, notes, and images, making them easy to find later. With features like auto-fetching, lists, and full-text search, Hoarder is the perfect tool for anyone who wants to keep track of their digital life.", + "install_methods": [ + { + "type": "default", + "script": "/ct/hoarder.sh", + "resources": { + "cpu": 2, + "ram": 4096, + "hdd": 8, + "os": "Debian", + "version": "12" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [] +}