New script: Part-DB LXC (#591)

* New script: Part-DB LXC * Improved based on PR feedback MickLesk * Migrate header & footer to latest version * formatting and remove old header * formatting * fix json --------- Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com>
2025-11-04 10:22:50 +00:00 · 2024-12-18 12:05:30 +01:00
parent 22c0757b4d
commit d0f2c71038
3 changed files with 236 additions and 0 deletions
--- a/ct/part-db.sh
+++ b/ct/part-db.sh
@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2024 community-scripts ORG
+# Author: bvdberg01
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://docs.part-db.de/
+
+# App Default Values
+APP="Part-DB"
+var_tags="inventory;parts"
+var_cpu="2"
+var_ram="1024"
+var_disk="8"
+var_os="debian"
+var_version="12"
+var_unprivileged="1"
+
+# App Output & Base Settings
+header_info "$APP"
+base_settings
+
+# Core
+variables
+color
+catch_errors
+
+function update_script() {
+  header_info
+  check_container_storage
+  check_container_resources
+  if [[ ! -d /opt/partdb ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+  RELEASE=$(curl -s https://api.github.com/repos/Part-DB/Part-DB-server/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+  if [[ ! -f /opt/${APP}_version.txt ]] || [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]]; then
+    msg_info "Stopping Service"
+    systemctl stop apache2
+    msg_ok "Stopped Service"
+
+    msg_info "Updating $APP to v${RELEASE}"
+    cd /opt
+    mv /opt/partdb/ /opt/partdb-backup
+    wget -q "https://github.com/Part-DB/Part-DB-server/archive/refs/tags/v${RELEASE}.zip"
+    unzip -q "v${RELEASE}.zip"
+    mv /opt/Part-DB-server-${RELEASE}/ /opt/partdb
+
+    cd /opt/partdb/
+    cp -r "/opt/partdb-backup/.env.local" /opt/partdb/
+    cp -r "/opt/partdb-backup/public/media" /opt/partdb/public/
+    cp -r "/opt/partdb-backup/config/banner.md" /opt/partdb/config/
+
+    export COMPOSER_ALLOW_SUPERUSER=1
+    composer install --no-dev -o --no-interaction &>/dev/null
+    yarn install &>/dev/null
+    yarn build &>/dev/null
+    php bin/console cache:clear &>/dev/null
+    php bin/console doctrine:migrations:migrate -n &>/dev/null
+    chown -R www-data:www-data /opt/partdb
+    echo "${RELEASE}" >/opt/${APP}_version.txt
+    msg_ok "Updated $APP to v${RELEASE}"
+
+    msg_info "Starting Service"
+    systemctl start apache2
+    msg_ok "Started Service"
+
+    msg_info "Cleaning up"
+    rm -r "/opt/v${RELEASE}.zip"
+    rm -r /opt/partdb-backup
+    msg_ok "Cleaned"
+    msg_ok "Updated Successfully"
+  else
+    msg_ok "No update required. ${APP} is already at v${RELEASE}"
+  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}"
--- a/install/part-db-install.sh
+++ b/install/part-db-install.sh
@@ -0,0 +1,112 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2024 community-scripts ORG
+# Author: bvdberg01
+# 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 \
+  curl \
+  sudo \
+  mc \
+  zip \
+  ca-certificates \
+  software-properties-common \
+  apt-transport-https \
+  lsb-release \
+  php-{opcache,curl,gd,mbstring,xml,bcmath,intl,zip,xsl,pgsql} \
+  libapache2-mod-php \
+  composer \
+  postgresql
+msg_ok "Installed Dependencies"
+
+msg_info "Setting up PostgreSQL"
+DB_NAME=partdb
+DB_USER=partdb
+DB_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | 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 TEMPLATE template0;"
+{
+echo "Part-DB Credentials"
+echo "Part-DB Database User: $DB_USER"
+echo "Part-DB Database Password: $DB_PASS"
+echo "Part-DB Database Name: $DB_NAME"
+} >> ~/partdb.creds
+msg_ok "Set up PostgreSQL"
+
+msg_info "Setting up Node.js/Yarn"
+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_20.x nodistro main" >/etc/apt/sources.list.d/nodesource.list
+$STD apt-get update
+$STD apt-get install -y nodejs
+$STD npm install -g npm@latest
+$STD npm install -g yarn
+msg_ok "Installed Node.js/Yarn"
+
+msg_info "Installing Part-DB (Patience)"
+cd /opt
+RELEASE=$(curl -s https://api.github.com/repos/Part-DB/Part-DB-server/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+wget -q "https://github.com/Part-DB/Part-DB-server/archive/refs/tags/v${RELEASE}.zip"
+unzip -q "v${RELEASE}.zip"
+mv /opt/Part-DB-server-${RELEASE}/ /opt/partdb
+
+cd /opt/partdb/
+cp .env .env.local
+sed -i "s|DATABASE_URL=\"sqlite:///%kernel.project_dir%/var/app.db\"|DATABASE_URL=\"postgresql://${DB_USER}:${DB_PASS}@127.0.0.1:5432/${DB_NAME}?serverVersion=12.19&charset=utf8\"|" .env.local
+
+export COMPOSER_ALLOW_SUPERUSER=1
+$STD composer install --no-dev -o --no-interaction
+$STD yarn install
+$STD yarn build
+$STD php bin/console cache:clear
+php bin/console doctrine:migrations:migrate -n > ~/database-migration-output
+chown -R www-data:www-data /opt/partdb
+ADMIN_PASS=$(grep -oP 'The initial password for the "admin" user is: \K\w+' ~/database-migration-output)
+{
+echo ""
+echo "Part-DB Admin User: admin"
+echo "Part-DB Admin Password: $ADMIN_PASS"
+} >> ~/partdb.creds
+echo "${RELEASE}" >/opt/${APPLICATION}_version.txt
+msg_ok "Installed Part-DB"
+
+msg_info "Creating Service"
+cat <<EOF >/etc/apache2/sites-available/partdb.conf
+<VirtualHost *:80>
+    ServerName partdb
+    DocumentRoot /opt/partdb/public
+    <Directory /opt/partdb/public>
+        Options FollowSymLinks
+        AllowOverride All
+        Require all granted
+    </Directory>
+
+    ErrorLog /var/log/apache2/partdb_error.log
+    CustomLog /var/log/apache2/partdb_access.log combined
+</VirtualHost>
+EOF
+$STD a2ensite partdb
+$STD a2enmod rewrite
+$STD a2dissite 000-default.conf
+$STD systemctl reload apache2
+msg_ok "Created Service"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+rm -rf ~/database-migration-output
+rm -rf "/opt/v${RELEASE}.zip"
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"
--- a/json/part-db.json
+++ b/json/part-db.json
@@ -0,0 +1,39 @@
+{
+    "name": "Part-DB",
+    "slug": "part-db",
+    "categories": [
+        0
+    ],
+    "date_created": "2024-12-18",
+    "type": "ct",
+    "updateable": true,
+    "privileged": false,
+    "interface_port": 80,
+    "documentation": "https://docs.part-db.de/",
+    "website": "https://github.com/Part-DB/Part-DB-server",
+    "logo": "https://avatars.githubusercontent.com/u/36010898?s=48&v=4",
+    "description": "Part-DB is an Open source inventory management system for your electronic components",
+    "install_methods": [
+        {
+            "type": "default",
+            "script": "ct/part-db.sh",
+            "resources": {
+                "cpu": 2,
+                "ram": 1024,
+                "hdd": 8,
+                "os": "debian",
+                "version": "12"
+            }
+        }
+    ],
+    "default_credentials": {
+        "username": null,
+        "password":  null
+    },
+    "notes": [
+        {
+            "text": "Show login and database credentials: `cat part-db.creds`",
+            "type": "info"
+        }
+    ]
+}