🔀 Merge pull request #2113 from Lissy93/fix/implementing-user-requests

Small fixes and implementing user requests

Author: Lissy93

.github/workflows/pr-quality-check.yml

@@ -11,6 +11,23 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  changes:
+    name: 🔎 Detect Changes
+    runs-on: ubuntu-latest
+    outputs:
+      lockfile: ${{ steps.filter.outputs.lockfile }}
+    steps:
+      - name: 🛎️ Checkout Code
+        uses: actions/checkout@v6
+
+      - name: 🔎 Filter Paths
+        uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            lockfile:
+              - 'yarn.lock'
+
   lint:
     name: 📝 Lint Code
     runs-on: ubuntu-latest
@@ -111,23 +128,24 @@ jobs:
         run: sh tests/docker-smoke-test.sh
         timeout-minutes: 10
 
-  # TODO: Re-enable security audit job
-  # security:
-  #   name: 🔒 Security Audit
-  #   runs-on: ubuntu-latest
-  #   continue-on-error: true
-  #   steps:
-  #     - name: 🛎️ Checkout Code
-  #       uses: actions/checkout@v6
-  #
-  #     - name: 🔧 Setup Node.js
-  #       uses: actions/setup-node@v6
-  #       with:
-  #         node-version: '20'
-  #         cache: 'yarn'
-  #
-  #     - name: 📦 Install Dependencies
-  #       run: yarn install --frozen-lockfile
-  #
-  #     - name: 🔒 Run Security Audit
-  #       run: yarn audit --level high
+  security:
+    name: 🔒 Security Audit
+    runs-on: ubuntu-latest
+    needs: changes
+    if: needs.changes.outputs.lockfile == 'true'
+    continue-on-error: true
+    steps:
+      - name: 🛎️ Checkout Code
+        uses: actions/checkout@v6
+
+      - name: 🔧 Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          cache: 'yarn'
+
+      - name: 📦 Install Dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: 🔒 Run Security Audit
+        run: yarn audit --level high

docs/developing.md

@@ -243,7 +243,6 @@ Styleguides:
 │  │  ├── CloudBackupRestore.vue  # Form where the user manages cloud sync options
 │  │  ├── ConfigContainer.vue     # Main container, wrapping all other config components
 │  │  ├── CustomCss.vue           # Form where the user can input custom CSS
-│  │  ├── EditSiteMeta.vue        # Form where the user can edit site meta data
 │  │  ╰── JsonEditor.vue          # JSON editor, where the user can modify the main config file
 │  ├── FormElements               # Basic form elements used throughout the app
 │  │  ├── Button.vue              # Standard button component

docs/management.md

@@ -105,6 +105,36 @@ docker run -d \
     willfarrell/autoheal
 ```
 
+### HTTP Healthcheck Endpoint
+
+Dashy also exposes an unauthenticated HTTP liveness endpoint at `/healthz`, which returns a `200` with a small JSON body (`status`, `uptime`, `version`). It bypasses auth and SSL redirection so probes keep working regardless of how Dashy is configured.
+
+Useful when fronting Dashy with a load balancer / reverse proxy that needs an HTTP probe for auto-failover, or when running on Kubernetes:
+
+```yaml
+# Kubernetes
+livenessProbe:
+  httpGet:
+    path: /healthz
+    port: 8080
+```
+
+```yaml
+# Traefik (label on the Dashy service)
+- "traefik.http.services.dashy.loadbalancer.healthcheck.path=/healthz"
+- "traefik.http.services.dashy.loadbalancer.healthcheck.interval=30s"
+```
+
+```caddyfile
+# Caddy (reverse_proxy block)
+reverse_proxy dashy:8080 {
+    health_uri  /healthz
+    health_interval 30s
+}
+```
+
+For Nginx Proxy Manager, set the *Forward Hostname* health-check path to `/healthz` under the proxy host's *Custom locations* / advanced config.
+
 **[⬆️ Back to Top](#management)**
 
 ---

docs/pages-and-sections.md

@@ -173,14 +173,15 @@ Item groups may also have an optional title.
   items:
   - title: Normal Item 1
   - title: Normal Item 2
-  - subItems:
+  - title: Languages
+    subItems:
     - title: JavaScript
       url: https://developer.mozilla.org
       icon: si-javascript
     - title: TypeScript
       url: https://www.typescriptlang.org/docs
       icon: si-typescript
-    - title: Svelt
+    - title: Svelte
       url: https://svelte.dev/docs
       icon: si-svelte
     - title: Go

docs/showcase.md

@@ -212,6 +212,14 @@
 
 ---
 
+## HomeLab 3.0
+
+> <sup>Re: [#1999](https://github.com/Lissy93/dashy/issues/1999)</sup>
+
+![screenshot-homelab-3](https://pixelflare.cc/alicia/dashy/12-skoogee-homelab-3)
+
+---
+
 ## Morning Dashboard
 
 > Displayed on my smart screen between 05:00 - 08:00, and includes all the info that I usually check before leaving for work

docs/widgets.md

@@ -618,7 +618,7 @@ This widget display email addresses / aliases from addy.io. Click an email addre
 
 **Field** | **Type** | **Required** | **Description**
 --- | --- | --- | ---
-**`apiKey`** | `string` |  Required | Your addy.io API Key / Personal Access Token. You can generate this under [Account Settings](https://app.addy.io/settings)
+**`apiKey`** | `string` |  Required | Your addy.io API Key / Personal Access Token. You can generate this under [API Settings](https://app.addy.io/settings/api)
 **`hostname`** | `string` |  _Optional_ | If your self-hosting addy.io, then supply the host name. By default it will use the public hosted instance
 **`apiVersion`** | `string` |  _Optional_ | If you're using an API version that is not version `v1`, then specify it here
 **`limit`** | `number` |  _Optional_ | Limit the number of emails shown per page. Defaults to `10`
@@ -631,7 +631,7 @@ This widget display email addresses / aliases from addy.io. Click an email addre
 #### Example
 
 ```yaml
-  - type: anonaddy
+  - type: addy
     options:
       apiKey: "xxxxxxxxxxxxxxxxxxxxxxxx\
         xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\

services/app.js

@@ -33,6 +33,7 @@ const getUser = require('./get-user'); // Enables server side user lookup
 
 /* Service endpoint URL paths (see also serviceEndpoints in src/utils/config/defaults.js) */
 const ENDPOINTS = {
+  health: '/healthz',
   statusPing: '/status-ping',
   statusCheck: '/status-check',
   save: '/config-manager/save',
@@ -41,6 +42,11 @@ const ENDPOINTS = {
   getUser: '/get-user',
 };
 
+/* Read package version once at startup, so healthcheck never touches the disk per-request */
+let appVersion = 'unknown';
+try { appVersion = require(path.join(rootDir, 'package.json')).version || 'unknown'; }
+catch { /* non-fatal — fall back to 'unknown' */ }
+
 /* Indicates for the webpack config, that running as a server */
 process.env.IS_SERVER = 'True';
 
@@ -173,6 +179,13 @@ function requireAdmin(req, res, next) {
 const method = (m, mw) => (req, res, next) => (req.method === m ? mw(req, res, next) : next());
 
 const app = express()
+  .get(ENDPOINTS.health, (req, res) => {
+    res.set('Cache-Control', 'no-store').status(200).json({
+      status: 'ok',
+      uptime: Math.round(process.uptime()),
+      version: appVersion,
+    });
+  })
   // Load SSL redirection middleware
   .use(sslServer.middleware)
   // Load middlewares for parsing JSON, and supporting HTML5 history routing

services/healthcheck.js

@@ -14,7 +14,6 @@ const httpsCerts = {
 /* Check if either if simular conditions exist that would of had ssl-server.js to enable ssl */
 const isSsl = !!fs.existsSync(httpsCerts.private) && !!fs.existsSync(httpsCerts.public);
 
-// eslint-disable-next-line import/no-dynamic-require
 const http = require(isSsl ? 'https' : 'http');
 
 /* Location of the server to test */
@@ -33,7 +32,7 @@ const agent = new http.Agent({
 });
 
 const requestOptions = {
-  host, port, timeout, agent,
+  host, port, timeout, agent, path: '/healthz',
 };
 
 const startTime = new Date(); // Initialize timestamp to calculate time taken