From 65ada6e6f343c38e71adadefaa86cfebec878eba Mon Sep 17 00:00:00 2001 From: "push-app-to-main[bot]" <203845782+push-app-to-main[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 14:26:41 +0200 Subject: [PATCH] Warracker (#7977) * 'Add new script' * Correct application name casing in warracker.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/warracker | 6 ++ ct/warracker.sh | 63 +++++++++++++++ frontend/public/json/warracker.json | 40 ++++++++++ install/warracker-install.sh | 119 ++++++++++++++++++++++++++++ 4 files changed, 228 insertions(+) create mode 100644 ct/headers/warracker create mode 100644 ct/warracker.sh create mode 100644 frontend/public/json/warracker.json create mode 100644 install/warracker-install.sh diff --git a/ct/headers/warracker b/ct/headers/warracker new file mode 100644 index 000000000..b9e7c55d2 --- /dev/null +++ b/ct/headers/warracker @@ -0,0 +1,6 @@ + __ + _ ______ _______________ ______/ /_____ _____ +| | /| / / __ `/ ___/ ___/ __ `/ ___/ //_/ _ \/ ___/ +| |/ |/ / /_/ / / / / / /_/ / /__/ ,< / __/ / +|__/|__/\__,_/_/ /_/ \__,_/\___/_/|_|\___/_/ + diff --git a/ct/warracker.sh b/ct/warracker.sh new file mode 100644 index 000000000..ccc3261ea --- /dev/null +++ b/ct/warracker.sh @@ -0,0 +1,63 @@ +#!/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: BvdBerg01 +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/sassanix/Warracker/ + +APP="Warracker" +var_tags="${var_tags:-warranty}" +var_cpu="${var_cpu:-1}" +var_ram="${var_ram:-512}" +var_disk="${var_disk:-4}" +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/warracker ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + if check_for_gh_release "warracker" "sassanix/Warracker"; then + msg_info "Stopping Services" + systemctl stop warrackermigration + systemctl stop warracker + systemctl stop nginx + msg_ok "Stopped Services" + + fetch_and_deploy_gh_release "warracker" "sassanix/Warracker" "tarball" "latest" "/opt/warracker" + + msg_info "Updating Warracker" + cd /opt/warracker/backend + $STD uv venv .venv + $STD source .venv/bin/activate + $STD uv pip install -r requirements.txt + msg_ok "Updated Warracker" + + msg_info "Starting Services" + systemctl start warracker + systemctl start nginx + 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}${CL}" diff --git a/frontend/public/json/warracker.json b/frontend/public/json/warracker.json new file mode 100644 index 000000000..a276b04dc --- /dev/null +++ b/frontend/public/json/warracker.json @@ -0,0 +1,40 @@ +{ + "name": "Warracker", + "slug": "warracker", + "categories": [ + 12 + ], + "date_created": "2025-09-19", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 80, + "documentation": null, + "config_path": "/opt/.env", + "website": "https://warracker.com/", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/warracker.webp", + "description": "Warracker is an open source, self-hostable warranty tracker to monitor expirations, store receipts, files. You own the data, your rules!", + "install_methods": [ + { + "type": "default", + "script": "ct/warracker.sh", + "resources": { + "cpu": 1, + "ram": 512, + "hdd": 4, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [ + { + "text": "The first user you register will be the admin user.", + "type": "info" + } + ] +} diff --git a/install/warracker-install.sh b/install/warracker-install.sh new file mode 100644 index 000000000..7bbe6f02c --- /dev/null +++ b/install/warracker-install.sh @@ -0,0 +1,119 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: bvdberg01 +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/sassanix/Warracker/ + +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 \ + build-essential \ + libpq-dev \ + nginx +msg_ok "Installed Dependencies" + +PYTHON_VERSION="3.12" setup_uv +PG_VERSION="17" setup_postgresql + +msg_info "Setup PostgreSQL" +DB_NAME="warranty_db" +DB_USER="warranty_user" +DB_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13) +DB_ADMIN_USER="warracker_admin" +DB_ADMIN_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13) +$STD sudo -u postgres psql -c "CREATE USER $DB_USER WITH PASSWORD '$DB_PASS';" +$STD sudo -u postgres psql -c "CREATE USER $DB_ADMIN_USER WITH PASSWORD '$DB_ADMIN_PASS' SUPERUSER;" +$STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME OWNER $DB_ADMIN_USER;" +$STD sudo -u postgres psql -d "$DB_NAME" -c "GRANT USAGE ON SCHEMA public TO $DB_USER;" +$STD sudo -u postgres psql -d "$DB_NAME" -c "GRANT CREATE ON SCHEMA public TO $DB_USER;" +$STD sudo -u postgres psql -d "$DB_NAME" -c "ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO $DB_USER;" +{ + echo "Application Credentials" + echo "DB_NAME: $DB_NAME" + echo "DB_USER: $DB_USER" + echo "DB_PASS: $DB_PASS" + echo "DB_ADMIN_USER: $DB_ADMIN_USER" + echo "DB_ADMIN_PASS: $DB_ADMIN_PASS" +} >>~/warracker.creds +msg_ok "Setup PostgreSQL" + +fetch_and_deploy_gh_release "warracker" "sassanix/Warracker" "tarball" "latest" "/opt/warracker" + +msg_info "Installing Warracker" +cd /opt/warracker/backend +$STD uv venv .venv +$STD source .venv/bin/activate +$STD uv pip install -r requirements.txt +mv /opt/warracker/env.example /opt/.env +sed -i \ + -e "s/your_secure_database_password/$DB_PASS/" \ + -e "s/your_secure_admin_password/$DB_ADMIN_PASS/" \ + -e "s|^# DB_PORT=5432$|DB_HOST=127.0.0.1|" \ + -e "s|your_very_secure_flask_secret_key_change_this_in_production|$(openssl rand -base64 32 | tr -d '\n')|" \ + /opt/.env +mkdir -p /data/uploads +msg_ok "Installed Warracker" + +msg_info "Configuring Nginx" +mv /opt/warracker/nginx.conf /etc/nginx/sites-available/warracker.conf +sed -i \ + -e "s|alias /var/www/html/locales/;|alias /opt/warracker/locales/;|" \ + -e "s|/var/www/html|/opt/warracker/frontend|g" \ + -e "s/client_max_body_size __NGINX_MAX_BODY_SIZE_CONFIG_VALUE__/client_max_body_size 32M/" \ + /etc/nginx/sites-available/warracker.conf +ln -s /etc/nginx/sites-available/warracker.conf /etc/nginx/sites-enabled/warracker.conf +rm /etc/nginx/sites-enabled/default +systemctl restart nginx + +msg_ok "Configured Nginx" + +msg_info "Creating systemd services" +cat </etc/systemd/system/warrackermigration.service +[Unit] +Description=Warracker Migration Service +After=network.target + +[Service] +Type=oneshot +WorkingDirectory=/opt/warracker/backend/migrations +EnvironmentFile=/opt/.env +ExecStart=/opt/warracker/backend/.venv/bin/python apply_migrations.py + +[Install] +WantedBy=multi-user.target +EOF + +cat </etc/systemd/system/warracker.service +[Unit] +Description=Warracker Service +After=network.target warrackermigration.service +Requires=warrackermigration.service + +[Service] +WorkingDirectory=/opt/warracker +EnvironmentFile=/opt/.env +ExecStart=/opt/warracker/backend/.venv/bin/gunicorn --config /opt/warracker/backend/gunicorn_config.py backend:create_app() --bind 127.0.0.1:5000 +Restart=always + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now warracker +msg_ok "Started Warracker Services" + +motd_ssh +customize + +msg_info "Cleaning up" +$STD apt -y autoremove +$STD apt -y autoclean +$STD apt -y clean +msg_ok "Cleaned"