diff --git a/ct/homelable.sh b/ct/homelable.sh new file mode 100644 index 00000000..709424b6 --- /dev/null +++ b/ct/homelable.sh @@ -0,0 +1,78 @@ +#!/usr/bin/env bash +source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func) +# Copyright (c) 2021-2026 community-scripts ORG +# Author: MickLesk +# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE +# Source: https://github.com/Pouzor/homelable + +APP="Homelable" +var_tags="${var_tags:-monitoring;network;visualization}" +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/homelable ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + if check_for_gh_release "homelable" "Pouzor/homelable"; then + msg_info "Stopping Service" + systemctl stop homelable + msg_ok "Stopped Service" + + msg_info "Backing up Configuration and Data" + cp /opt/homelable/backend/.env /opt/homelable.env.bak + cp -r /opt/homelable/data /opt/homelable_data_bak + msg_ok "Backed up Configuration and Data" + + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "homelable" "Pouzor/homelable" "tarball" "latest" "/opt/homelable" + + msg_info "Updating Python Dependencies" + cd /opt/homelable/backend + $STD uv venv /opt/homelable/backend/.venv + $STD uv pip install --python /opt/homelable/backend/.venv/bin/python -r requirements.txt + msg_ok "Updated Python Dependencies" + + msg_info "Rebuilding Frontend" + cd /opt/homelable/frontend + $STD npm ci + $STD npm run build + msg_ok "Rebuilt Frontend" + + msg_info "Restoring Configuration and Data" + cp /opt/homelable.env.bak /opt/homelable/backend/.env + cp -r /opt/homelable_data_bak/. /opt/homelable/data/ + rm -f /opt/homelable.env.bak + rm -rf /opt/homelable_data_bak + msg_ok "Restored Configuration and Data" + + msg_info "Starting Service" + systemctl start homelable + msg_ok "Started Service" + 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}:3000${CL}" diff --git a/install/homelable-install.sh b/install/homelable-install.sh new file mode 100644 index 00000000..9a8f86bd --- /dev/null +++ b/install/homelable-install.sh @@ -0,0 +1,103 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: MickLesk +# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE +# Source: https://github.com/Pouzor/homelable + +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 \ + nmap \ + iputils-ping \ + caddy +msg_ok "Installed Dependencies" + +UV_PYTHON="3.13" setup_uv +NODE_VERSION="20" setup_nodejs +fetch_and_deploy_gh_release "homelable" "Pouzor/homelable" "tarball" "latest" "/opt/homelable" + +msg_info "Setting up Python Backend" +cd /opt/homelable/backend +$STD uv venv /opt/homelable/backend/.venv +$STD uv pip install --python /opt/homelable/backend/.venv/bin/python -r requirements.txt +msg_ok "Set up Python Backend" + +msg_info "Configuring Homelable" +mkdir -p /opt/homelable/data +SECRET_KEY=$(openssl rand -hex 32) +BCRYPT_HASH=$(/opt/homelable/backend/.venv/bin/python -c "from passlib.context import CryptContext; print(CryptContext(schemes=['bcrypt']).hash('admin'))") +cat </opt/homelable/backend/.env +SECRET_KEY=${SECRET_KEY} +SQLITE_PATH=/opt/homelable/data/homelab.db +CORS_ORIGINS=["http://localhost:3000","http://${LOCAL_IP}:3000"] +AUTH_USERNAME=admin +AUTH_PASSWORD_HASH='${BCRYPT_HASH}' +SCANNER_RANGES=["192.168.1.0/24"] +STATUS_CHECKER_INTERVAL=60 +EOF +msg_ok "Configured Homelable" + +msg_info "Building Frontend" +cd /opt/homelable/frontend +$STD npm ci +$STD npm run build +msg_ok "Built Frontend" + +msg_info "Creating Service" +cat </etc/systemd/system/homelable.service +[Unit] +Description=Homelable Backend +After=network.target + +[Service] +Type=simple +WorkingDirectory=/opt/homelable/backend +EnvironmentFile=/opt/homelable/backend/.env +ExecStart=/opt/homelable/backend/.venv/bin/uvicorn app.main:app --host 127.0.0.1 --port 8000 +Restart=on-failure +RestartSec=5 + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now homelable +msg_ok "Created Service" + +msg_info "Configuring Caddy" +cat </etc/caddy/Caddyfile +:3000 { + root * /opt/homelable/frontend/dist + file_server + + @websocket path /api/v1/status/ws/* + handle @websocket { + reverse_proxy 127.0.0.1:8000 + } + + handle /ws/* { + reverse_proxy 127.0.0.1:8000 + } + + handle /api/* { + reverse_proxy 127.0.0.1:8000 + } + + handle { + try_files {path} {path}.html /index.html + } +} +EOF +systemctl reload caddy +msg_ok "Configured Caddy" + +motd_ssh +customize +cleanup_lxc diff --git a/json/homelable.json b/json/homelable.json new file mode 100644 index 00000000..256d39a9 --- /dev/null +++ b/json/homelable.json @@ -0,0 +1,38 @@ +{ + "name": "Homelable", + "slug": "homelable", + "categories": [9], + "date_created": "2026-03-30", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 3000, + "documentation": "https://github.com/Pouzor/homelable/blob/main/INSTALLATION.md", + "website": "https://github.com/Pouzor/homelable", + "logo": "https://raw.githubusercontent.com/Pouzor/homelable/main/frontend/public/logo.svg", + "config_path": "/opt/homelable/backend/.env", + "description": "Homelable is an interactive homelab network visualization and monitoring tool. Map your infrastructure on a drag-and-drop canvas with live node status checks (ping, HTTP, TCP, SSH), network scanning via nmap, and hardware spec tracking.", + "install_methods": [ + { + "type": "default", + "script": "ct/homelable.sh", + "resources": { + "cpu": 2, + "ram": 2048, + "hdd": 8, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": "admin", + "password": "admin" + }, + "notes": [ + { + "text": "Change the default password after first login!", + "type": "warning" + } + ] +}