From 4b0d24ed2e1f79b4c0319fbe6121dab41ab712ee Mon Sep 17 00:00:00 2001 From: "push-app-to-main[bot]" <203845782+push-app-to-main[bot]@users.noreply.github.com> Date: Fri, 8 Aug 2025 08:23:14 +0200 Subject: [PATCH] Palmr (#6642) * 'Add new script' * Update palmr.sh * Update palmr-install.sh --------- Co-authored-by: push-app-to-main[bot] <203845782+push-app-to-main[bot]@users.noreply.github.com> Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com> --- ct/headers/palmr | 6 +++ ct/palmr.sh | 80 ++++++++++++++++++++++++++++ frontend/public/json/palmr.json | 44 ++++++++++++++++ install/palmr-install.sh | 92 +++++++++++++++++++++++++++++++++ 4 files changed, 222 insertions(+) create mode 100644 ct/headers/palmr create mode 100644 ct/palmr.sh create mode 100644 frontend/public/json/palmr.json create mode 100644 install/palmr-install.sh diff --git a/ct/headers/palmr b/ct/headers/palmr new file mode 100644 index 000000000..c485f3c60 --- /dev/null +++ b/ct/headers/palmr @@ -0,0 +1,6 @@ + ____ __ + / __ \____ _/ /___ ___ _____ + / /_/ / __ `/ / __ `__ \/ ___/ + / ____/ /_/ / / / / / / / / +/_/ \__,_/_/_/ /_/ /_/_/ + diff --git a/ct/palmr.sh b/ct/palmr.sh new file mode 100644 index 000000000..6839b0510 --- /dev/null +++ b/ct/palmr.sh @@ -0,0 +1,80 @@ +#!/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: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/kyantech/Palmr + +APP="Palmr" +var_tags="${var_tags:-files}" +var_cpu="${var_cpu:-4}" +var_ram="${var_ram:-4096}" +var_disk="${var_disk:-6}" +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/palmr_data ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + RELEASE=$(curl -fsSL https://api.github.com/repos/kyantech/palmr/releases/latest | jq '.tag_name' | sed 's/^v//') + if [[ "${RELEASE}" != "$(cat ~/.palmr 2>/dev/null)" ]] || [[ ! -f ~/.palmr ]]; then + msg_info "Stopping Services" + systemctl stop palmr-frontend palmr-backend + msg_ok "Stopped Services" + + cp /opt/palmr/apps/server/.env /opt/palmr.env + rm -rf /opt/palmr + fetch_and_deploy_gh_release "Palmr" "kyantech/Palmr" "tarball" "latest" "/opt/palmr" + + PNPM="$(jq -r '.packageManager' /opt/palmr/package.json)" + NODE_VERSION="20" NODE_MODULE="$PNPM" setup_nodejs + + msg_info "Updating ${APP}" + cd /opt/palmr/apps/server + mv /opt/palmr.env /opt/palmr/apps/server/.env + $STD pnpm install + $STD pnpm dlx prisma generate + $STD pnpm dlx prisma migrate deploy + $STD pnpm dlx prisma db push + $STD pnpm build + + cd /opt/palmr/apps/web + export NODE_ENV=production + export NEXT_TELEMETRY_DISABLED=1 + mv ./.env.example ./.env + $STD pnpm install + $STD pnpm build + chown -R palmr:palmr /opt/palmr_data /opt/palmr + msg_ok "Updated $APP" + + msg_info "Starting Services" + systemctl start palmr-backend palmr-frontend + msg_ok "Started Services" + + msg_ok "Updated Successfully" + else + msg_ok "Already up to date" + 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}" diff --git a/frontend/public/json/palmr.json b/frontend/public/json/palmr.json new file mode 100644 index 000000000..0f5fffd2c --- /dev/null +++ b/frontend/public/json/palmr.json @@ -0,0 +1,44 @@ +{ + "name": "Palmr", + "slug": "palmr", + "categories": [ + 11 + ], + "date_created": "2025-08-03", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 3000, + "documentation": "https://palmr.kyantech.com.br/docs/3.1-beta", + "config_path": "/opt/palmr/apps/server/.env, /opt/palmr/apps/web/.env", + "website": "https://palmr.kyantech.com.br/", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/palmr.webp", + "description": "Palmr is a fast and secure platform for sharing files, built with performance and privacy in mind.", + "install_methods": [ + { + "type": "default", + "script": "ct/palmr.sh", + "resources": { + "cpu": 4, + "ram": 4096, + "hdd": 6, + "os": "Debian", + "version": "12" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [ + { + "text": "To use a bind mount for storage, create symlinks to your mount for both `uploads` and `temp-uploads` in `/opt/palmr_data`", + "type": "info" + }, + { + "text": "To use Palmr with a reverse proxy, uncomment `SECURE_SITE` in `/opt/palmr/apps/server/.env`", + "type": "info" + } + ] +} diff --git a/install/palmr-install.sh b/install/palmr-install.sh new file mode 100644 index 000000000..44ac96719 --- /dev/null +++ b/install/palmr-install.sh @@ -0,0 +1,92 @@ +#!/usr/bin/env bash + +# Copyright (c) 2025 Community Scripts ORG +# Author: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/kyantech/Palmr + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +fetch_and_deploy_gh_release "Palmr" "kyantech/Palmr" "tarball" "latest" "/opt/palmr" +PNPM="$(jq -r '.packageManager' /opt/palmr/package.json)" NODE_VERSION="20" NODE_MODULE="$PNPM" setup_nodejs + +msg_info "Configuring palmr backend" +PALMR_DIR="/opt/palmr_data" +mkdir -p "$PALMR_DIR" +PALMR_DB="${PALMR_DIR}/palmr.db" +PALMR_KEY="$(openssl rand -hex 32)" +cd /opt/palmr/apps/server +sed -e 's/_ENCRYPTION=true/_ENCRYPTION=false/' \ + -e '/^# ENC/s/# //' \ + -e "s/ENCRYPTION_KEY=.*$/ENCRYPTION_KEY=$PALMR_KEY/" \ + -e "s|file:.*$|file:$PALMR_DB\"|" \ + -e '/db"$/a\# Uncomment below when using reverse proxy\ +# SECURE_SITE=true' \ + .env.example >./.env +$STD pnpm install +$STD pnpm dlx prisma generate +$STD pnpm dlx prisma migrate deploy +$STD pnpm dlx prisma db push +$STD pnpm db:seed +$STD pnpm build +msg_ok "Configured palmr backend" + +msg_info "Configuring palmr frontend" +cd /opt/palmr/apps/web +mv ./.env.example ./.env +export NODE_ENV=production +export NEXT_TELEMETRY_DISABLED=1 +$STD pnpm install +$STD pnpm build +msg_ok "Configured palmr frontend" + +msg_info "Creating service" +useradd -d "$PALMR_DIR" -M -s /usr/sbin/nologin -U palmr +chown -R palmr:palmr "$PALMR_DIR" /opt/palmr +cat </etc/systemd/system/palmr-backend.service +[Unit] +Description=palmr Backend Service +After=network.target + +[Service] +Type=simple +User=palmr +Group=palmr +WorkingDirectory=/opt/palmr_data +ExecStart=/usr/bin/node /opt/palmr/apps/server/dist/server.js + +[Install] +WantedBy=multi-user.target +EOF + +cat </etc/systemd/system/palmr-frontend.service +[Unit] +Description=palmr Frontend Service +After=network.target palmr-backend.service + +[Service] +Type=simple +User=palmr +Group=palmr +WorkingDirectory=/opt/palmr/apps/web +ExecStart=/usr/bin/pnpm start + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now palmr-backend palmr-frontend +msg_ok "Created service" + +motd_ssh +customize + +msg_info "Cleaning up" +$STD apt-get -y autoremove +$STD apt-get -y autoclean +msg_ok "Cleaned"