@simplehomelab/deployrr 6.0.0-rc3

package/apps/official/glances/manifest.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "glances",
+    "pname": "Glances",
+    "description": "Glances is a cross-platform system monitoring tool that provides a comprehensive overview of your system's performance including CPU, memory, disk, network, and Docker container metrics.",
+    "descriptionShort": "System and Docker metrics monitoring",
+    "icon": "sh-glances",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["monitoring", "system", "metrics", "docker"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["monitoring", "all"],
+    "networks": ["default", "socket_proxy"],
+    "webui": true,
+    "port": 61208,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": ["socket-proxy"]
+  },
+
+  "files": [
+    {
+      "source": "files/glances.conf",
+      "dest": "$DOCKER_FOLDER/appdata/glances/glances.conf"
+    }
+  ],
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "GLANCES_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "GLANCES_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 61208,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_glances_status",
+    "successMessage": "Glances Setup Completed",
+    "telemetryAction": "glances"
+  }
+}

package/apps/official/gluetun/compose.yml

@@ -0,0 +1,33 @@
+services:
+  # Gluetun - VPN Client for Docker Containers and More
+  # Gluetun only for use by torrent clients + on demand lan devices.
+  # Arr apps do not need VPN (not recommended), unless you have ISP/country restrictions.
+  gluetun:
+    image: qmcgaw/gluetun
+    container_name: gluetun
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["core", "all"]
+    networks:
+      - default
+    cap_add:
+      - NET_ADMIN
+    devices:
+      - /dev/net/tun
+    # ports:
+      # - $QBITTORRENTVPN_PORT:8080 # qBittorrent available at http://DOCKER-HOST-IP:$QBITTORRENTVPN_PORT
+      # - 8888:8888/tcp # HTTP proxy
+      # - 8388:8388/tcp # Shadowsocks
+      # - 8388:8388/udp # Shadowsocks
+    volumes:
+      - $DOCKERDIR/appdata/gluetun:/gluetun
+    environment:
+      TZ: $TZ
+      VPN_SERVICE_PROVIDER: $GLUETUN_VPN_SERVICE_PROVIDER
+      VPN_TYPE: $GLUETUN_VPN_TYPE
+      # WIREGUARD_PRIVATE_KEY: $GLUETUN_WIREGUARD_PRIVATE_KEY
+      # WIREGUARD_ADDRESSES: $GLUETUN_WIREGUARD_ADDRESSES
+      # OPENVPN_USER: $GLUETUN_OPENVPN_USERNAME
+      # OPENVPN_PASSWORD: $GLUETUN_OPENVPN_PASSWORD
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/gluetun/files/post-install.sh

@@ -0,0 +1,78 @@
+#!/bin/bash
+# Gluetun post-install hook
+# Handles conditional VPN type configuration and connection verification
+
+APP_SNAME="gluetun"
+APP_PNAME="Gluetun"
+APP_COMPOSE_FILE="$DOCKER_FOLDER/compose/$HOSTNAME/$APP_SNAME.yml"
+
+# Get VPN type from environment
+VPN_TYPE="$GLUETUN_VPN_TYPE"
+
+f_print_step "1/4" "Configuring $APP_PNAME for $VPN_TYPE..."
+echo
+
+if [[ "$VPN_TYPE" == "wireguard" ]]; then
+    f_print_substep "Collecting WireGuard credentials"
+
+    # Prompt for WireGuard-specific variables
+    f_update_envars "GLUETUN_WIREGUARD_PRIVATE_KEY" "$GLUETUN_WIREGUARD_PRIVATE_KEY" "Enter the \\Z2Private Key\\Zn from the configuration provided by the Provider:"
+    f_update_envars "GLUETUN_WIREGUARD_ADDRESSES" "$GLUETUN_WIREGUARD_ADDRESSES" "Enter the \\Z2Wireguard Addresses\\Zn from the configuration provided by the Provider (usually of the format XX.XX.XX.XX/XX):"
+
+    # Uncomment WireGuard lines in compose file
+    f_print_step "2/4" "Updating compose file for WireGuard..."
+    f_sed_replace "# WIREGUARD_PRIVATE_KEY:" "WIREGUARD_PRIVATE_KEY:" "$APP_COMPOSE_FILE"
+    f_sed_replace "# WIREGUARD_ADDRESSES:" "WIREGUARD_ADDRESSES:" "$APP_COMPOSE_FILE"
+    echo
+
+elif [[ "$VPN_TYPE" == "openvpn" ]]; then
+    f_print_substep "Collecting OpenVPN credentials"
+
+    # Prompt for OpenVPN-specific variables
+    f_update_envars "GLUETUN_OPENVPN_USERNAME" "$GLUETUN_OPENVPN_USERNAME" "Enter the \\Z2OpenVPN Username\\Zn from the Provider:"
+    f_update_envars "GLUETUN_OPENVPN_PASSWORD" "$GLUETUN_OPENVPN_PASSWORD" "Enter the \\Z2OpenVPN Password\\Zn from the Provider:"
+
+    # Uncomment OpenVPN lines in compose file
+    f_print_step "2/4" "Updating compose file for OpenVPN..."
+    f_sed_replace "# OPENVPN_USER:" "OPENVPN_USER:" "$APP_COMPOSE_FILE"
+    f_sed_replace "# OPENVPN_PASSWORD:" "OPENVPN_PASSWORD:" "$APP_COMPOSE_FILE"
+    echo
+
+else
+    f_print_warning "Unknown VPN type: $VPN_TYPE. Please verify your configuration."
+fi
+
+f_print_step "3/4" "Recreating $APP_PNAME container with VPN configuration..."
+f_docker_compose_recreate "$APP_SNAME" "06"
+echo
+
+f_print_step "4/4" "Waiting for $APP_PNAME to connect to VPN..."
+TIMEOUT=0
+TIMEOUT_LIMIT=60
+GLUETUN_CONNECTED="false"
+
+while [[ "$GLUETUN_CONNECTED" != "true" ]]; do
+    if [[ $TIMEOUT -ge $TIMEOUT_LIMIT ]]; then
+        f_print_error "Timed out after ${TIMEOUT_LIMIT}s. Could not verify VPN connection."
+        f_print_warning "Check container logs with: sudo docker logs gluetun"
+        break
+    fi
+
+    # Check if container is running
+    CONTAINER_RUNNING="$(sudo docker container inspect -f '{{.State.Running}}' gluetun 2>/dev/null)"
+    if [[ "$CONTAINER_RUNNING" == "true" ]]; then
+        # Check logs for successful VPN connection
+        if sudo docker logs gluetun 2>&1 | grep -q "Public IP address is"; then
+            GLUETUN_CONNECTED="true"
+            PUBLIC_IP=$(sudo docker logs gluetun 2>&1 | grep "Public IP address is" | tail -1 | sed 's/.*Public IP address is //')
+            f_print_success "VPN connected successfully!"
+            f_print_substep "Public IP: $PUBLIC_IP"
+        fi
+    fi
+
+    ((TIMEOUT++))
+    sleep 1
+done
+
+echo
+f_print_success "$APP_PNAME configuration complete"

package/apps/official/gluetun/manifest.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "gluetun",
+    "pname": "Gluetun",
+    "description": "Gluetun is a lightweight, portable VPN client for Docker that supports multiple VPN providers. It acts as a VPN killswitch and can route traffic from other containers through the VPN tunnel.",
+    "descriptionShort": "Docker VPN Client",
+    "icon": "sh-gluetun",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["vpn", "networking", "security", "privacy"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["core", "all"],
+    "networks": ["default"],
+    "webui": false,
+    "port": 0,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites", "network_adapter"],
+    "apps": []
+  },
+
+  "traefik": {
+    "supported": false
+  },
+
+  "dashboard": {
+    "enabled": false,
+    "location": "local",
+    "showStats": false,
+    "portVariable": null
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "GLUETUN_VPN_SERVICE_PROVIDER",
+        "description": "VPN Provider (case-sensitive, e.g. surfshark, nordvpn, mullvad)",
+        "type": "string",
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "GLUETUN_VPN_TYPE",
+        "description": "VPN Type (openvpn or wireguard)",
+        "type": "string",
+        "default": "wireguard",
+        "prompt": true,
+        "required": true
+      }
+    ]
+  },
+
+  "hooks": {
+    "postInstall": {
+      "script": "files/post-install.sh",
+      "messages": [
+        {
+          "style": "note",
+          "text": "Gluetun allows advanced configurations (e.g. selecting VPN countries). Reference: https://www.simplehomelab.com/gluetun-docker-guide/"
+        }
+      ]
+    }
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "info",
+        "text": "To route other containers through Gluetun, add 'network_mode: service:gluetun' to their compose configuration."
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_gluetun_status",
+    "successMessage": "Gluetun Setup Completed",
+    "telemetryAction": "gluetun"
+  }
+}

package/apps/official/gonic/compose.yml

@@ -0,0 +1,26 @@
+services:
+  # Gonic - Music Server
+  gonic:
+    container_name: gonic
+    image: sentriz/gonic:latest
+    security_opt:
+      - no-new-privileges:true
+    restart: "no"
+    profiles: ["media", "all"]
+    networks:
+      - default
+    ports:
+      - "$GONIC_PORT:80"
+    volumes:
+      - $DOCKERDIR/appdata/gonic/data:/data
+      - $DOCKERDIR/appdata/gonic/podcasts:/podcasts
+      - $DOCKERDIR/appdata/gonic/cache:/cache
+      - $DOCKERDIR/appdata/gonic/playlists:/playlists
+      # - $MEDIADIR1:/data/media1
+      # - $MEDIADIR2:/data/media2
+      # - $MEDIADIR3:/data/media3
+    environment:
+      - PUID=$PUID
+      - PGID=$PGID
+      - TZ=$TZ
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/gonic/manifest.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "gonic",
+    "pname": "Gonic",
+    "description": "Gonic is a free music server implementing the Subsonic API. It supports on-the-fly transcoding and audio scrobbling.",
+    "descriptionShort": "Music server",
+    "icon": "sh-gonic",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["music", "media", "streaming", "subsonic"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["media", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 82,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites", "media_folder", "appfolder_permission"],
+    "apps": []
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "note",
+        "text": "$APP_PNAME default username/password are: admin/admin"
+      }
+    ]
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "GONIC_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "GONIC_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 82,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "folders": {
+    "appdata": ["data", "podcasts", "cache", "playlists"]
+  },
+
+  "status": {
+    "file": "06_gonic_status",
+    "successMessage": "Gonic Setup Completed",
+    "telemetryAction": "gonic"
+  }
+}

package/apps/official/gptwol/compose.yml

@@ -0,0 +1,23 @@
+services:
+  # GPTWOL - Wake On LAN Docker GUI
+  gptwol:
+    container_name: gptwol
+    image: misterbabou/gptwol:latest
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    network_mode: host
+    stdin_open: true
+    tty: true
+    environment:
+      - PUID=$PUID
+      - PGID=$PGID
+      - TZ=$TZ
+      - PORT=$GPTWOL_PORT # default port is 5000
+      - REFRESH_PING=60 # in seconds
+      # - PING_TIMEOUT=200 # in milliseconds
+    volumes:
+      - $DOCKERDIR/appdata/gptwol/db:/app/db
+      - $DOCKERDIR/appdata/gptwol/cron:/etc/cron.d
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/gptwol/manifest.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "gptwol",
+    "pname": "GPTWOL",
+    "description": "GPTWOL is a Wake On LAN Docker GUI that allows you to wake up devices on your network from a web interface.",
+    "descriptionShort": "Wake On LAN Docker GUI",
+    "icon": "sh-gptwol",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["wake-on-lan", "network", "utilities"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": [],
+    "webui": true,
+    "port": 5000,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "folders": {
+    "appdata": ["db", "cron"],
+    "permissions": {
+      "appdata": "$PUID:$PGID"
+    }
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "warning",
+        "text": "Don't expose GPTWOL without a strong authentication."
+      }
+    ]
+  },
+
+  "traefik": {
+    "supported": false
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "GPTWOL_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "GPTWOL_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 5000,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_gptwol_status",
+    "successMessage": "GPTWOL Setup Completed",
+    "telemetryAction": "gptwol"
+  }
+}

package/apps/official/grafana/compose.yml

@@ -0,0 +1,19 @@
+services:
+  # Grafana - Graphical data visualization for InfluxDB data
+  grafana:
+    image: grafana/grafana:latest
+    container_name: grafana
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$GRAFANA_PORT:3000"
+    user: $PUID
+    volumes:
+      - $DOCKERDIR/appdata/grafana:/var/lib/grafana
+    environment:
+      GF_INSTALL_PLUGINS: "grafana-clock-panel,grafana-simple-json-datasource,grafana-worldmap-panel,grafana-piechart-panel,cloudflare-app"
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/grafana/manifest.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "grafana",
+    "pname": "Grafana",
+    "description": "Grafana is the open source analytics and monitoring solution for every database. Create, explore, and share dashboards with your team.",
+    "descriptionShort": "Dashboarding and visualization",
+    "icon": "sh-grafana",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["monitoring", "visualization", "dashboards", "analytics"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 3001,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "folders": {
+    "appdata": [],
+    "permissions": {
+      "appdata": "$PUID:$PGID"
+    }
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "note",
+        "text": "Grafana default username/password are: admin/admin."
+      }
+    ]
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "GRAFANA_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "GRAFANA_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 3001,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_grafana_status",
+    "successMessage": "Grafana Setup Completed",
+    "telemetryAction": "grafana"
+  }
+}

package/apps/official/grocy/compose.yml

@@ -0,0 +1,20 @@
+services:
+  # Grocy - ERP System for the Kitchen
+  grocy:
+    image: lscr.io/linuxserver/grocy:latest
+    container_name: grocy
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$GROCY_PORT:80"
+    volumes:
+      - $DOCKERDIR/appdata/grocy:/config
+    environment:
+      PUID: $PUID
+      PGID: $PGID
+      TZ: $TZ
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/grocy/manifest.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "grocy",
+    "pname": "Grocy",
+    "description": "Grocy is a self-hosted ERP system for your kitchen and household. It helps you track groceries, manage recipes, meal planning, shopping lists, and household chores.",
+    "descriptionShort": "ERP System for the Kitchen",
+    "icon": "sh-grocy",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["home", "groceries", "recipes", "household"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "note",
+        "text": "$APP_PNAME default username/password are: admin/admin"
+      }
+    ]
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "GROCY_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "GROCY_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_grocy_status",
+    "successMessage": "Grocy Setup Completed",
+    "telemetryAction": "grocy"
+  }
+}