diff --git a/src/app/docs/catalog/actual-budget/page.tsx b/src/app/docs/catalog/actual-budget/page.tsx new file mode 100644 index 0000000..fe40fee --- /dev/null +++ b/src/app/docs/catalog/actual-budget/page.tsx @@ -0,0 +1,128 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Actual Budget — DashCaddy Docs', + description: 'Install and configure Actual Budget via DashCaddy. Privacy-focused budgeting app with envelope budgeting', +}; + +export default function actualBudgetDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Easy + Docker image: actualbudget/actual-server:latest +
+ +

What is Actual Budget?

+

Privacy-focused budgeting app with envelope budgeting

+

Actual Budget ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Actual Budget, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Actual Budget from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the actualbudget/actual-server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for budget.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "actual-budget",
+    "host": "local",
+    "subdomain": "budget",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Actual Budget on my home host and expose it at budget.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Create your first budget in the web interface
    2. +
  2. Import transactions from your bank (OFX, QFX, CSV)
    3. +
  3. Set up envelope categories for spending control
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/actual-budget/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull actualbudget/actual-server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Actual Budget → Update.

+ +

Backups

+

The config volume for Actual Budget is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Actual Budget:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Actual Budget is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: actual-budget. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/adminer/page.tsx b/src/app/docs/catalog/adminer/page.tsx new file mode 100644 index 0000000..9ae0cf9 --- /dev/null +++ b/src/app/docs/catalog/adminer/page.tsx @@ -0,0 +1,129 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Adminer — DashCaddy Docs', + description: 'Install and configure Adminer via DashCaddy. Lightweight database management in single PHP file', +}; + +export default function adminerDocsPage() { + return ( +
+ + +
+ Category: Database + Difficulty: Easy + Docker image: adminer:latest +
+ +

What is Adminer?

+

Lightweight database management in single PHP file

+

Adminer ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Adminer, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Adminer from the Database category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the adminer:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for adminer.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "adminer",
+    "host": "local",
+    "subdomain": "adminer",
+    "port": "{{PORT}}",
+    "environment": {
+      "ADMINER_DEFAULT_SERVER": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Adminer on my home host and expose it at adminer.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Connect to your database servers
    2. +
  2. Supports MySQL, PostgreSQL, SQLite, etc.
    3. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/adminer:/var/www/html
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • ADMINER_DEFAULT_SERVER
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull adminer:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Adminer → Update.

+ +

Backups

+

The config volume for Adminer is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Adminer:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Adminer is in the Database category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: adminer. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/airsonic/page.tsx b/src/app/docs/catalog/airsonic/page.tsx new file mode 100644 index 0000000..f1e57d2 --- /dev/null +++ b/src/app/docs/catalog/airsonic/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Airsonic Advanced — DashCaddy Docs', + description: 'Install and configure Airsonic Advanced via DashCaddy. Free web-based media streamer', +}; + +export default function airsonicDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: linuxserver/airsonic-advanced:latest +
+ +

What is Airsonic Advanced?

+

Free web-based media streamer

+

Airsonic Advanced ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Airsonic Advanced, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Airsonic Advanced from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/airsonic-advanced:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for airsonic.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "airsonic",
+    "host": "local",
+    "subdomain": "airsonic",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Airsonic Advanced on my home host and expose it at airsonic.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Default login: admin/admin
    2. +
  2. Configure media folders
    3. +
  3. Set up transcoding
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/airsonic/config:/config
    • +
  • /music:/music
    • +
  • /podcasts:/podcasts
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/airsonic-advanced:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Airsonic Advanced → Update.

+ +

Backups

+

The config volume for Airsonic Advanced is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Airsonic Advanced:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Airsonic Advanced is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: airsonic. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/audiobookshelf/page.tsx b/src/app/docs/catalog/audiobookshelf/page.tsx new file mode 100644 index 0000000..4b6b9fc --- /dev/null +++ b/src/app/docs/catalog/audiobookshelf/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Audiobookshelf — DashCaddy Docs', + description: 'Install and configure Audiobookshelf via DashCaddy. Self-hosted audiobook and podcast server', +}; + +export default function audiobookshelfDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: ghcr.io/advplyr/audiobookshelf:latest +
+ +

What is Audiobookshelf?

+

Self-hosted audiobook and podcast server

+

Audiobookshelf ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Audiobookshelf, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • A host path to mount as the media library (default: /media/audiobooks).
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Audiobookshelf from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/advplyr/audiobookshelf:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for audiobooks.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "audiobookshelf",
+    "host": "local",
+    "subdomain": "audiobooks",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Audiobookshelf on my home host and expose it at audiobooks.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Create your account on first access
    2. +
  2. Add your audiobook library folders
    3. +
  3. Download the mobile app for offline listening
    4. +
+ +

Media library path notes

+

The media mount path you set at deploy time is what Audiobookshelf will see as /audiobooks. For multi-library setups (movies + TV + music), bind the parent folder and let Audiobookshelf discover subfolders automatically.

+
    +
  • Permissions: Audiobookshelf runs as a non-root user. Make sure your media files are readable by UID 1000 (or whichever the container expects — check the Logs tab on first run).
    • +
  • Performance: Put the media library on the same storage pool as DashCaddy itself; cross-pool mounts add 10–30% latency on first scan.
    • +
+ + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/audiobookshelf/config:/config
    • +
  • /opt/audiobookshelf/metadata:/metadata
    • +
  • MEDIA_PATH:/audiobooks
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/advplyr/audiobookshelf:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Audiobookshelf → Update.

+ +

Backups

+

The config volume for Audiobookshelf is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Audiobookshelf:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • +
  • Library shows empty: confirm the media mount path is readable by the container UID and that the directory contains the file extensions Audiobookshelf indexes.
    • + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Audiobookshelf is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: audiobookshelf. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/authentik/page.tsx b/src/app/docs/catalog/authentik/page.tsx new file mode 100644 index 0000000..4e01638 --- /dev/null +++ b/src/app/docs/catalog/authentik/page.tsx @@ -0,0 +1,135 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Authentik — DashCaddy Docs', + description: 'Install and configure Authentik via DashCaddy. Identity provider and single sign-on platform', +}; + +export default function authentikDocsPage() { + return ( +
+ + +
+ Category: Security + Difficulty: Advanced + Docker image: ghcr.io/goauthentik/server:latest +
+ +

What is Authentik?

+

Identity provider and single sign-on platform

+

Authentik ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Authentik, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Authentik from the Security category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/goauthentik/server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for auth.<your-domain>.
      5. +
    5. Wait for the container health check (/-/health/live/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "authentik",
+    "host": "local",
+    "subdomain": "auth",
+    "port": "{{PORT}}",
+    "environment": {
+      "AUTHENTIK_SECRET_KEY": "",
+      "AUTHENTIK_ERROR_REPORTING__ENABLED": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Authentik on my home host and expose it at auth.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Requires a PostgreSQL database and Redis instance
    2. +
  2. Consider deploying via the Dev Environment recipe for full stack
    3. +
  3. Set up flows for authentication, enrollment, and recovery
    4. +
  4. Configure OAuth2/OIDC providers for SSO with other apps
    5. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/authentik/media:/media
    • +
  • /opt/authentik/templates:/templates
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • AUTHENTIK_SECRET_KEY
    • +
  • AUTHENTIK_ERROR_REPORTING__ENABLED
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/goauthentik/server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Authentik → Update.

+ +

Backups

+

The config volume for Authentik is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Authentik:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Authentik is in the Security category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: authentik. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/bazarr/page.tsx b/src/app/docs/catalog/bazarr/page.tsx new file mode 100644 index 0000000..1dc0232 --- /dev/null +++ b/src/app/docs/catalog/bazarr/page.tsx @@ -0,0 +1,138 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Bazarr — DashCaddy Docs', + description: 'Install and configure Bazarr via DashCaddy. Automatic subtitle downloader for Sonarr and Radarr', +}; + +export default function bazarrDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Easy + Docker image: linuxserver/bazarr:latest +
+ +

What is Bazarr?

+

Automatic subtitle downloader for Sonarr and Radarr

+

Bazarr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Bazarr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Bazarr from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/bazarr:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for bazarr.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "bazarr",
+    "host": "local",
+    "subdomain": "bazarr",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Bazarr on my home host and expose it at bazarr.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Connect to Sonarr and Radarr
    2. +
  2. Configure subtitle providers
    3. +
  3. Set language preferences
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/bazarr/config:/config
    • +
  • /movies:/movies
    • +
  • /tv:/tv
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/bazarr:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Bazarr → Update.

+ +

Backups

+

The config volume for Bazarr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Bazarr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Bazarr is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: bazarr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/bind9/page.tsx b/src/app/docs/catalog/bind9/page.tsx new file mode 100644 index 0000000..7c325d3 --- /dev/null +++ b/src/app/docs/catalog/bind9/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install BIND9 DNS Server — DashCaddy Docs', + description: 'Install and configure BIND9 DNS Server via DashCaddy. Industry-standard DNS server - powerful and flexible', +}; + +export default function bind9DocsPage() { + return ( +
+ + +
+ Category: DNS + Difficulty: Advanced + Docker image: ubuntu/bind9:latest +
+ +

What is BIND9 DNS Server?

+

Industry-standard DNS server - powerful and flexible

+

BIND9 DNS Server ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using BIND9 DNS Server, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select BIND9 DNS Server from the DNS category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ubuntu/bind9:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for dns2.<your-domain>.
      5. +
    5. Wait for the container health check (tcp://localhost:53) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "bind9",
+    "host": "local",
+    "subdomain": "dns2",
+    "port": "{{PORT}}",
+    "environment": {
+      "BIND9_USER": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy BIND9 DNS Server on my home host and expose it at dns2.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure zone files in /opt/bind9/config/
    2. +
  2. Create named.conf.local for your .sami zone
    3. +
  3. Add zone file: /opt/bind9/records/db.sami
    4. +
  4. Restart container to apply changes
    5. +
  5. Test with: dig @localhost sami
    6. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/bind9/config:/etc/bind
    • +
  • /opt/bind9/cache:/var/cache/bind
    • +
  • /opt/bind9/records:/var/lib/bind
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • BIND9_USER
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ubuntu/bind9:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → BIND9 DNS Server → Update.

+ +

Backups

+

The config volume for BIND9 DNS Server is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with BIND9 DNS Server:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

BIND9 DNS Server is in the DNS category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: bind9. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/bookstack/page.tsx b/src/app/docs/catalog/bookstack/page.tsx new file mode 100644 index 0000000..7704928 --- /dev/null +++ b/src/app/docs/catalog/bookstack/page.tsx @@ -0,0 +1,142 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install BookStack — DashCaddy Docs', + description: 'Install and configure BookStack via DashCaddy. Simple wiki and documentation platform', +}; + +export default function bookstackDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Intermediate + Docker image: linuxserver/bookstack:latest +
+ +

What is BookStack?

+

Simple wiki and documentation platform

+

BookStack ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using BookStack, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select BookStack from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/bookstack:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for wiki.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "bookstack",
+    "host": "local",
+    "subdomain": "wiki",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "APP_URL": "",
+      "DB_HOST": "",
+      "DB_DATABASE": "",
+      "DB_USERNAME": "",
+      "DB_PASSWORD": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy BookStack on my home host and expose it at wiki.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Requires MariaDB/MySQL database
    2. +
  2. Default login: admin@admin.com / password
    3. +
  3. Change default credentials
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/bookstack/config:/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • APP_URL
    • +
  • DB_HOST
    • +
  • DB_DATABASE
    • +
  • DB_USERNAME
    • +
  • DB_PASSWORD
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/bookstack:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → BookStack → Update.

+ +

Backups

+

The config volume for BookStack is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with BookStack:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

BookStack is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: bookstack. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/calibre-web/page.tsx b/src/app/docs/catalog/calibre-web/page.tsx new file mode 100644 index 0000000..f26a2c8 --- /dev/null +++ b/src/app/docs/catalog/calibre-web/page.tsx @@ -0,0 +1,141 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Calibre-Web — DashCaddy Docs', + description: 'Install and configure Calibre-Web via DashCaddy. Web-based ebook manager and reader', +}; + +export default function calibreWebDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Intermediate + Docker image: lscr.io/linuxserver/calibre-web:latest +
+ +

What is Calibre-Web?

+

Web-based ebook manager and reader

+

Calibre-Web ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Calibre-Web, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • A host path to mount as the media library (default: /media/books).
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Calibre-Web from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the lscr.io/linuxserver/calibre-web:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for books.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "calibre-web",
+    "host": "local",
+    "subdomain": "books",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Calibre-Web on my home host and expose it at books.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Default login: admin / admin123
    2. +
  2. Point to your Calibre database location on first setup
    3. +
  3. Supports EPUB, PDF, MOBI, and more formats
    4. +
+ +

Media library path notes

+

The media mount path you set at deploy time is what Calibre-Web will see as /books. For multi-library setups (movies + TV + music), bind the parent folder and let Calibre-Web discover subfolders automatically.

+
    +
  • Permissions: Calibre-Web runs as a non-root user. Make sure your media files are readable by UID 1000 (or whichever the container expects — check the Logs tab on first run).
    • +
  • Performance: Put the media library on the same storage pool as DashCaddy itself; cross-pool mounts add 10–30% latency on first scan.
    • +
+ + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/calibre-web/config:/config
    • +
  • MEDIA_PATH:/books
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull lscr.io/linuxserver/calibre-web:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Calibre-Web → Update.

+ +

Backups

+

The config volume for Calibre-Web is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Calibre-Web:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • +
  • Library shows empty: confirm the media mount path is readable by the container UID and that the directory contains the file extensions Calibre-Web indexes.
    • + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Calibre-Web is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: calibre-web. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/changedetection/page.tsx b/src/app/docs/catalog/changedetection/page.tsx new file mode 100644 index 0000000..e56beab --- /dev/null +++ b/src/app/docs/catalog/changedetection/page.tsx @@ -0,0 +1,128 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Change Detection — DashCaddy Docs', + description: 'Install and configure Change Detection via DashCaddy. Monitor websites for changes', +}; + +export default function changedetectionDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: ghcr.io/dgtlmoon/changedetection.io:latest +
+ +

What is Change Detection?

+

Monitor websites for changes

+

Change Detection ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Change Detection, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Change Detection from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/dgtlmoon/changedetection.io:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for watch.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "changedetection",
+    "host": "local",
+    "subdomain": "watch",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Change Detection on my home host and expose it at watch.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Add URLs to monitor
    2. +
  2. Configure check frequency
    3. +
  3. Set up notifications
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/changedetection/data:/datastore
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/dgtlmoon/changedetection.io:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Change Detection → Update.

+ +

Backups

+

The config volume for Change Detection is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Change Detection:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Change Detection is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: changedetection. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/coredns/page.tsx b/src/app/docs/catalog/coredns/page.tsx new file mode 100644 index 0000000..0015f05 --- /dev/null +++ b/src/app/docs/catalog/coredns/page.tsx @@ -0,0 +1,130 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install CoreDNS — DashCaddy Docs', + description: 'Install and configure CoreDNS via DashCaddy. Cloud-native DNS server - lightweight and flexible', +}; + +export default function corednsDocsPage() { + return ( +
+ + +
+ Category: DNS + Difficulty: Intermediate + Docker image: coredns/coredns:latest +
+ +

What is CoreDNS?

+

Cloud-native DNS server - lightweight and flexible

+

CoreDNS ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using CoreDNS, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select CoreDNS from the DNS category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the coredns/coredns:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for dns4.<your-domain>.
      5. +
    5. Wait for the container health check (tcp://localhost:53) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "coredns",
+    "host": "local",
+    "subdomain": "dns4",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy CoreDNS on my home host and expose it at dns4.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Create Corefile in /opt/coredns/config/
    2. +
  2. Define .sami zone with file plugin
    3. +
  3. Create zone file with your records
    4. +
  4. Restart container to load config
    5. +
  5. Test with: dig @localhost test.sami
    6. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/coredns/config:/etc/coredns
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull coredns/coredns:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → CoreDNS → Update.

+ +

Backups

+

The config volume for CoreDNS is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with CoreDNS:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

CoreDNS is in the DNS category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: coredns. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/crowdsec/page.tsx b/src/app/docs/catalog/crowdsec/page.tsx new file mode 100644 index 0000000..8fd90cd --- /dev/null +++ b/src/app/docs/catalog/crowdsec/page.tsx @@ -0,0 +1,131 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install CrowdSec — DashCaddy Docs', + description: 'Install and configure CrowdSec via DashCaddy. Collaborative intrusion prevention system', +}; + +export default function crowdsecDocsPage() { + return ( +
+ + +
+ Category: Security + Difficulty: Intermediate + Docker image: crowdsecurity/crowdsec:latest +
+ +

What is CrowdSec?

+

Collaborative intrusion prevention system

+

CrowdSec ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using CrowdSec, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select CrowdSec from the Security category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the crowdsecurity/crowdsec:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for crowdsec.<your-domain>.
      5. +
    5. Wait for the container health check (/health) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "crowdsec",
+    "host": "local",
+    "subdomain": "crowdsec",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy CrowdSec on my home host and expose it at crowdsec.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Register at app.crowdsec.net for community threat intelligence
    2. +
  2. Install bouncers on your reverse proxy for active blocking
    3. +
  3. CrowdSec analyzes logs and shares threat data with the community
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/crowdsec/config:/etc/crowdsec
    • +
  • /opt/crowdsec/data:/var/lib/crowdsec/data
    • +
  • /var/log:/var/log:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull crowdsecurity/crowdsec:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → CrowdSec → Update.

+ +

Backups

+

The config volume for CrowdSec is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with CrowdSec:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

CrowdSec is in the Security category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: crowdsec. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/dashca/page.tsx b/src/app/docs/catalog/dashca/page.tsx new file mode 100644 index 0000000..7d181c4 --- /dev/null +++ b/src/app/docs/catalog/dashca/page.tsx @@ -0,0 +1,130 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install DashCA — DashCaddy Docs', + description: 'Install and configure DashCA via DashCaddy. One-click root CA certificate installer for your network', +}; + +export default function dashcaDocsPage() { + return ( +
+ + +
+ Category: Security + Difficulty: Easy + Docker image: N/A +
+ +

What is DashCA?

+

One-click root CA certificate installer for your network

+

DashCA ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using DashCA, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select DashCA from the Security category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the N/A image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for ca.<your-domain>.
      5. +
    5. Wait for the container health check (/healthz) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "dashca",
+    "host": "local",
+    "subdomain": "ca",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy DashCA on my home host and expose it at ca.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. New devices: visit http://ca.sami (HTTP, no certificate needed)
    2. +
  2. Click the 'Install Certificate' button for your platform
    3. +
  3. Follow platform-specific instructions
    4. +
  4. Verify all *.sami domains now show secure connections
    5. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    + +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull N/A every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → DashCA → Update.

+ +

Backups

+

The config volume for DashCA is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with DashCA:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

DashCA is in the Security category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: dashca. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/digital-clock/page.tsx b/src/app/docs/catalog/digital-clock/page.tsx new file mode 100644 index 0000000..526e44a --- /dev/null +++ b/src/app/docs/catalog/digital-clock/page.tsx @@ -0,0 +1,127 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Digital Clock — DashCaddy Docs', + description: 'Install and configure Digital Clock via DashCaddy. Live digital clock with time, date, and day of week', +}; + +export default function digitalClockDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: N/A +
+ +

What is Digital Clock?

+

Live digital clock with time, date, and day of week

+

Digital Clock ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Digital Clock, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Digital Clock from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the N/A image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for digital-clock.<your-domain>.
      5. +
    5. Wait for the container health check (/healthz) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "digital-clock",
+    "host": "local",
+    "subdomain": "digital-clock",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Digital Clock on my home host and expose it at digital-clock.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Clock appears in the top bar to the right of the weather widget
    2. +
  2. No configuration needed — runs automatically
    3. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    + +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull N/A every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Digital Clock → Update.

+ +

Backups

+

The config volume for Digital Clock is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Digital Clock:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Digital Clock is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: digital-clock. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/dozzle/page.tsx b/src/app/docs/catalog/dozzle/page.tsx new file mode 100644 index 0000000..a6e5aa3 --- /dev/null +++ b/src/app/docs/catalog/dozzle/page.tsx @@ -0,0 +1,129 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Dozzle — DashCaddy Docs', + description: 'Install and configure Dozzle via DashCaddy. Real-time Docker container log viewer', +}; + +export default function dozzleDocsPage() { + return ( +
+ + +
+ Category: Monitoring + Difficulty: Easy + Docker image: amir20/dozzle:latest +
+ +

What is Dozzle?

+

Real-time Docker container log viewer

+

Dozzle ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Dozzle, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Dozzle from the Monitoring category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the amir20/dozzle:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for logs.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "dozzle",
+    "host": "local",
+    "subdomain": "logs",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Dozzle on my home host and expose it at logs.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. View real-time logs from all running containers
    2. +
  2. Filter and search across container logs
    3. +
  3. No configuration needed - auto-discovers containers
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /var/run/docker.sock:/var/run/docker.sock:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull amir20/dozzle:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Dozzle → Update.

+ +

Backups

+

The config volume for Dozzle is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Dozzle:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Dozzle is in the Monitoring category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: dozzle. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/drone/page.tsx b/src/app/docs/catalog/drone/page.tsx new file mode 100644 index 0000000..c38e2d6 --- /dev/null +++ b/src/app/docs/catalog/drone/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Drone CI — DashCaddy Docs', + description: 'Install and configure Drone CI via DashCaddy. Container-native continuous delivery platform', +}; + +export default function droneDocsPage() { + return ( +
+ + +
+ Category: Development + Difficulty: Intermediate + Docker image: drone/drone:latest +
+ +

What is Drone CI?

+

Container-native continuous delivery platform

+

Drone CI ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Drone CI, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Drone CI from the Development category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the drone/drone:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for drone.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "drone",
+    "host": "local",
+    "subdomain": "drone",
+    "port": "{{PORT}}",
+    "environment": {
+      "DRONE_GITEA_SERVER": "",
+      "DRONE_RPC_SECRET": "",
+      "DRONE_SERVER_HOST": "",
+      "DRONE_SERVER_PROTO": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Drone CI on my home host and expose it at drone.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure Git provider integration
    2. +
  2. Set up shared secret
    3. +
  3. Deploy Drone runners
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/drone/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • DRONE_GITEA_SERVER
    • +
  • DRONE_RPC_SECRET
    • +
  • DRONE_SERVER_HOST
    • +
  • DRONE_SERVER_PROTO
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull drone/drone:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Drone CI → Update.

+ +

Backups

+

The config volume for Drone CI is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Drone CI:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Drone CI is in the Development category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: drone. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/emby/page.tsx b/src/app/docs/catalog/emby/page.tsx new file mode 100644 index 0000000..86de5a7 --- /dev/null +++ b/src/app/docs/catalog/emby/page.tsx @@ -0,0 +1,141 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Emby — DashCaddy Docs', + description: 'Install and configure Emby via DashCaddy. Personal media server with apps for all devices', +}; + +export default function embyDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: emby/embyserver:latest +
+ +

What is Emby?

+

Personal media server with apps for all devices

+

Emby ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Emby, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • A host path to mount as the media library (default: /media).
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Emby from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the emby/embyserver:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for emby.<your-domain>.
      5. +
    5. Wait for the container health check (/emby/web/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "emby",
+    "host": "local",
+    "subdomain": "emby",
+    "port": "{{PORT}}",
+    "environment": {
+      "UID": "",
+      "GID": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Emby on my home host and expose it at emby.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Complete the initial setup wizard at the web interface
    2. +
  2. Add your media libraries (Movies, TV Shows, Music)
    3. +
  3. Configure user accounts and permissions
    4. +
  4. Install Emby apps on your devices for remote access
    5. +
+ +

Media library path notes

+

The media mount path you set at deploy time is what Emby will see as /media. For multi-library setups (movies + TV + music), bind the parent folder and let Emby discover subfolders automatically.

+
    +
  • Permissions: Emby runs as a non-root user. Make sure your media files are readable by UID 1000 (or whichever the container expects — check the Logs tab on first run).
    • +
  • Performance: Put the media library on the same storage pool as DashCaddy itself; cross-pool mounts add 10–30% latency on first scan.
    • +
+ + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/emby/config:/config
    • +
  • /opt/emby/cache:/cache
    • +
  • MEDIA_PATH:/media
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • UID
    • +
  • GID
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull emby/embyserver:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Emby → Update.

+ +

Backups

+

The config volume for Emby is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Emby:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • +
  • Library shows empty: confirm the media mount path is readable by the container UID and that the directory contains the file extensions Emby indexes.
    • + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Emby is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: emby. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/excalidraw/page.tsx b/src/app/docs/catalog/excalidraw/page.tsx new file mode 100644 index 0000000..21fdd25 --- /dev/null +++ b/src/app/docs/catalog/excalidraw/page.tsx @@ -0,0 +1,128 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Excalidraw — DashCaddy Docs', + description: 'Install and configure Excalidraw via DashCaddy. Collaborative virtual whiteboard for sketching and diagrams', +}; + +export default function excalidrawDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Easy + Docker image: excalidraw/excalidraw:latest +
+ +

What is Excalidraw?

+

Collaborative virtual whiteboard for sketching and diagrams

+

Excalidraw ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Excalidraw, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Excalidraw from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the excalidraw/excalidraw:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for draw.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "excalidraw",
+    "host": "local",
+    "subdomain": "draw",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Excalidraw on my home host and expose it at draw.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Start drawing immediately - no account needed
    2. +
  2. Share drawings via link for real-time collaboration
    3. +
  3. Export as PNG, SVG, or Excalidraw file
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/excalidraw/data:/var/lib/excalidraw
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull excalidraw/excalidraw:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Excalidraw → Update.

+ +

Backups

+

The config volume for Excalidraw is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Excalidraw:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Excalidraw is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: excalidraw. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/filebrowser/page.tsx b/src/app/docs/catalog/filebrowser/page.tsx new file mode 100644 index 0000000..ae19b3b --- /dev/null +++ b/src/app/docs/catalog/filebrowser/page.tsx @@ -0,0 +1,129 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install FileBrowser — DashCaddy Docs', + description: 'Install and configure FileBrowser via DashCaddy. Web-based file manager with sharing capabilities', +}; + +export default function filebrowserDocsPage() { + return ( +
+ + +
+ Category: Files + Difficulty: Easy + Docker image: filebrowser/filebrowser:latest +
+ +

What is FileBrowser?

+

Web-based file manager with sharing capabilities

+

FileBrowser ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using FileBrowser, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select FileBrowser from the Files category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the filebrowser/filebrowser:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for files.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "filebrowser",
+    "host": "local",
+    "subdomain": "files",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy FileBrowser on my home host and expose it at files.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Default login: admin/admin
    2. +
  2. Change default password immediately
    3. +
  3. Configure user permissions and shares
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/filebrowser/data:/srv
    • +
  • /opt/filebrowser/database:/database
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull filebrowser/filebrowser:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → FileBrowser → Update.

+ +

Backups

+

The config volume for FileBrowser is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with FileBrowser:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

FileBrowser is in the Files category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: filebrowser. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/gitea/page.tsx b/src/app/docs/catalog/gitea/page.tsx new file mode 100644 index 0000000..0c55243 --- /dev/null +++ b/src/app/docs/catalog/gitea/page.tsx @@ -0,0 +1,135 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Gitea — DashCaddy Docs', + description: 'Install and configure Gitea via DashCaddy. Lightweight self-hosted Git service', +}; + +export default function giteaDocsPage() { + return ( +
+ + +
+ Category: Development + Difficulty: Easy + Docker image: gitea/gitea:latest +
+ +

What is Gitea?

+

Lightweight self-hosted Git service

+

Gitea ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Gitea, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Gitea from the Development category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the gitea/gitea:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for gitea.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "gitea",
+    "host": "local",
+    "subdomain": "gitea",
+    "port": "{{PORT}}",
+    "environment": {
+      "USER_UID": "",
+      "USER_GID": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Gitea on my home host and expose it at gitea.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Complete initial setup wizard
    2. +
  2. Create admin account
    3. +
  3. Configure SSH access
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/gitea/data:/data
    • +
  • /etc/timezone:/etc/timezone:ro
    • +
  • /etc/localtime:/etc/localtime:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • USER_UID
    • +
  • USER_GID
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull gitea/gitea:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Gitea → Update.

+ +

Backups

+

The config volume for Gitea is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Gitea:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Gitea is in the Development category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: gitea. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/grafana/page.tsx b/src/app/docs/catalog/grafana/page.tsx new file mode 100644 index 0000000..7a588c1 --- /dev/null +++ b/src/app/docs/catalog/grafana/page.tsx @@ -0,0 +1,131 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Grafana — DashCaddy Docs', + description: 'Install and configure Grafana via DashCaddy. Analytics and interactive visualization platform', +}; + +export default function grafanaDocsPage() { + return ( +
+ + +
+ Category: Monitoring + Difficulty: Advanced + Docker image: grafana/grafana:latest +
+ +

What is Grafana?

+

Analytics and interactive visualization platform

+

Grafana ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Grafana, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Grafana from the Monitoring category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the grafana/grafana:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for grafana.<your-domain>.
      5. +
    5. Wait for the container health check (/api/health) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "grafana",
+    "host": "local",
+    "subdomain": "grafana",
+    "port": "{{PORT}}",
+    "environment": {
+      "GF_SECURITY_ADMIN_PASSWORD": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Grafana on my home host and expose it at grafana.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Open the new grafana.<your-domain> URL.
    2. +
  2. Complete the upstream Grafana setup wizard (create admin user, accept EULA, etc.).
    3. +
  3. Configure backups from Settings → Backups — the default daily snapshot will capture the data volume.
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/grafana/data:/var/lib/grafana
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • GF_SECURITY_ADMIN_PASSWORD
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull grafana/grafana:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Grafana → Update.

+ +

Backups

+

The config volume for Grafana is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Grafana:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Grafana is in the Monitoring category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: grafana. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/homarr/page.tsx b/src/app/docs/catalog/homarr/page.tsx new file mode 100644 index 0000000..c71088b --- /dev/null +++ b/src/app/docs/catalog/homarr/page.tsx @@ -0,0 +1,130 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Homarr — DashCaddy Docs', + description: 'Install and configure Homarr via DashCaddy. Sleek dashboard for all your services', +}; + +export default function homarrDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: ghcr.io/ajnart/homarr:latest +
+ +

What is Homarr?

+

Sleek dashboard for all your services

+

Homarr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Homarr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Homarr from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/ajnart/homarr:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for homarr.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "homarr",
+    "host": "local",
+    "subdomain": "homarr",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Homarr on my home host and expose it at homarr.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Add your services via UI
    2. +
  2. Configure integrations
    3. +
  3. Customize layout and appearance
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/homarr/configs:/app/data/configs
    • +
  • /opt/homarr/icons:/app/public/icons
    • +
  • /var/run/docker.sock:/var/run/docker.sock:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/ajnart/homarr:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Homarr → Update.

+ +

Backups

+

The config volume for Homarr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Homarr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Homarr is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: homarr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/homeassistant/page.tsx b/src/app/docs/catalog/homeassistant/page.tsx new file mode 100644 index 0000000..a4490e7 --- /dev/null +++ b/src/app/docs/catalog/homeassistant/page.tsx @@ -0,0 +1,131 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Home Assistant — DashCaddy Docs', + description: 'Install and configure Home Assistant via DashCaddy. Open source home automation platform', +}; + +export default function homeassistantDocsPage() { + return ( +
+ + +
+ Category: Home Automation + Difficulty: Intermediate + Docker image: homeassistant/home-assistant:stable +
+ +

What is Home Assistant?

+

Open source home automation platform

+

Home Assistant ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Home Assistant, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Home Assistant from the Home Automation category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the homeassistant/home-assistant:stable image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for home.<your-domain>.
      5. +
    5. Wait for the container health check (/api/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "homeassistant",
+    "host": "local",
+    "subdomain": "home",
+    "port": "{{PORT}}",
+    "environment": {
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Home Assistant on my home host and expose it at home.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Complete onboarding wizard
    2. +
  2. Add integrations for your smart devices
    3. +
  3. Create automations and dashboards
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/homeassistant/config:/config
    • +
  • /etc/localtime:/etc/localtime:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull homeassistant/home-assistant:stable every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Home Assistant → Update.

+ +

Backups

+

The config volume for Home Assistant is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Home Assistant:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Home Assistant is in the Home Automation category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: homeassistant. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/homepage/page.tsx b/src/app/docs/catalog/homepage/page.tsx new file mode 100644 index 0000000..e9a4ac2 --- /dev/null +++ b/src/app/docs/catalog/homepage/page.tsx @@ -0,0 +1,129 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Homepage — DashCaddy Docs', + description: 'Install and configure Homepage via DashCaddy. Highly customizable application dashboard', +}; + +export default function homepageDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: ghcr.io/gethomepage/homepage:latest +
+ +

What is Homepage?

+

Highly customizable application dashboard

+

Homepage ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Homepage, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Homepage from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/gethomepage/homepage:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for dashboard.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "homepage",
+    "host": "local",
+    "subdomain": "dashboard",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Homepage on my home host and expose it at dashboard.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Edit config files to add services
    2. +
  2. Configure widgets
    3. +
  3. Customize appearance
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/homepage/config:/app/config
    • +
  • /var/run/docker.sock:/var/run/docker.sock:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/gethomepage/homepage:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Homepage → Update.

+ +

Backups

+

The config volume for Homepage is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Homepage:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Homepage is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: homepage. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/immich/page.tsx b/src/app/docs/catalog/immich/page.tsx new file mode 100644 index 0000000..f9578bb --- /dev/null +++ b/src/app/docs/catalog/immich/page.tsx @@ -0,0 +1,140 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Immich — DashCaddy Docs', + description: 'Install and configure Immich via DashCaddy. Self-hosted Google Photos alternative', +}; + +export default function immichDocsPage() { + return ( +
+ + +
+ Category: Photos + Difficulty: Intermediate + Docker image: ghcr.io/immich-app/immich-server:latest +
+ +

What is Immich?

+

Self-hosted Google Photos alternative

+

Immich ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Immich, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Immich from the Photos category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/immich-app/immich-server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for photos.<your-domain>.
      5. +
    5. Wait for the container health check (/api/server-info/ping) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "immich",
+    "host": "local",
+    "subdomain": "photos",
+    "port": "{{PORT}}",
+    "environment": {
+      "DB_HOSTNAME": "",
+      "DB_USERNAME": "",
+      "DB_PASSWORD": "",
+      "DB_DATABASE_NAME": "",
+      "REDIS_HOSTNAME": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Immich on my home host and expose it at photos.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Requires PostgreSQL and Redis
    2. +
  2. Install mobile apps for backup
    3. +
  3. Configure machine learning for face detection
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/immich/upload:/usr/src/app/upload
    • +
  • /opt/immich/library:/usr/src/app/library
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • DB_HOSTNAME
    • +
  • DB_USERNAME
    • +
  • DB_PASSWORD
    • +
  • DB_DATABASE_NAME
    • +
  • REDIS_HOSTNAME
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/immich-app/immich-server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Immich → Update.

+ +

Backups

+

The config volume for Immich is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Immich:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Immich is in the Photos category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: immich. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/it-tools/page.tsx b/src/app/docs/catalog/it-tools/page.tsx new file mode 100644 index 0000000..5944ee1 --- /dev/null +++ b/src/app/docs/catalog/it-tools/page.tsx @@ -0,0 +1,128 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install IT Tools — DashCaddy Docs', + description: 'Install and configure IT Tools via DashCaddy. Collection of handy developer and IT tools in one place', +}; + +export default function itToolsDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: corentinth/it-tools:latest +
+ +

What is IT Tools?

+

Collection of handy developer and IT tools in one place

+

IT Tools ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using IT Tools, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select IT Tools from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the corentinth/it-tools:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for tools.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "it-tools",
+    "host": "local",
+    "subdomain": "tools",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy IT Tools on my home host and expose it at tools.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Access the web interface for instant tools access
    2. +
  2. Includes: hash generators, UUID, JWT decoder, base64, regex tester, and 70+ more
    3. +
  3. No configuration needed
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/it-tools/config:/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull corentinth/it-tools:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → IT Tools → Update.

+ +

Backups

+

The config volume for IT Tools is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with IT Tools:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

IT Tools is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: it-tools. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/jdownloader/page.tsx b/src/app/docs/catalog/jdownloader/page.tsx new file mode 100644 index 0000000..de7d80e --- /dev/null +++ b/src/app/docs/catalog/jdownloader/page.tsx @@ -0,0 +1,130 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install JDownloader 2 — DashCaddy Docs', + description: 'Install and configure JDownloader 2 via DashCaddy. Download manager for file hosting sites', +}; + +export default function jdownloaderDocsPage() { + return ( +
+ + +
+ Category: Downloads + Difficulty: Easy + Docker image: jlesage/jdownloader-2:latest +
+ +

What is JDownloader 2?

+

Download manager for file hosting sites

+

JDownloader 2 ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using JDownloader 2, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select JDownloader 2 from the Downloads category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the jlesage/jdownloader-2:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for jdownloader.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "jdownloader",
+    "host": "local",
+    "subdomain": "jdownloader",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy JDownloader 2 on my home host and expose it at jdownloader.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Access web interface to configure
    2. +
  2. Link to MyJDownloader account
    3. +
  3. Configure download paths
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/jdownloader/config:/config
    • +
  • /downloads:/output
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull jlesage/jdownloader-2:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → JDownloader 2 → Update.

+ +

Backups

+

The config volume for JDownloader 2 is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with JDownloader 2:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

JDownloader 2 is in the Downloads category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: jdownloader. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/jellyfin/page.tsx b/src/app/docs/catalog/jellyfin/page.tsx new file mode 100644 index 0000000..38a98d8 --- /dev/null +++ b/src/app/docs/catalog/jellyfin/page.tsx @@ -0,0 +1,139 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Jellyfin — DashCaddy Docs', + description: 'Install and configure Jellyfin via DashCaddy. Free software media system - alternative to Plex', +}; + +export default function jellyfinDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: jellyfin/jellyfin:latest +
+ +

What is Jellyfin?

+

Free software media system - alternative to Plex

+

Jellyfin ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Jellyfin, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • A host path to mount as the media library (default: /media).
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Jellyfin from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the jellyfin/jellyfin:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for jellyfin.<your-domain>.
      5. +
    5. Wait for the container health check (/health) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "jellyfin",
+    "host": "local",
+    "subdomain": "jellyfin",
+    "port": "{{PORT}}",
+    "environment": {
+      "JELLYFIN_PublishedServerUrl": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Jellyfin on my home host and expose it at jellyfin.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Complete the initial setup wizard
    2. +
  2. Add your media libraries
    3. +
  3. Configure user accounts and permissions
    4. +
+ +

Media library path notes

+

The media mount path you set at deploy time is what Jellyfin will see as /media. For multi-library setups (movies + TV + music), bind the parent folder and let Jellyfin discover subfolders automatically.

+
    +
  • Permissions: Jellyfin runs as a non-root user. Make sure your media files are readable by UID 1000 (or whichever the container expects — check the Logs tab on first run).
    • +
  • Performance: Put the media library on the same storage pool as DashCaddy itself; cross-pool mounts add 10–30% latency on first scan.
    • +
+ + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/jellyfin/config:/config
    • +
  • /opt/jellyfin/cache:/cache
    • +
  • MEDIA_PATH:/media
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • JELLYFIN_PublishedServerUrl
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull jellyfin/jellyfin:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Jellyfin → Update.

+ +

Backups

+

The config volume for Jellyfin is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Jellyfin:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • +
  • Library shows empty: confirm the media mount path is readable by the container UID and that the directory contains the file extensions Jellyfin indexes.
    • + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Jellyfin is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: jellyfin. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/jenkins/page.tsx b/src/app/docs/catalog/jenkins/page.tsx new file mode 100644 index 0000000..7fd9eed --- /dev/null +++ b/src/app/docs/catalog/jenkins/page.tsx @@ -0,0 +1,128 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Jenkins — DashCaddy Docs', + description: 'Install and configure Jenkins via DashCaddy. Automation server for CI/CD pipelines', +}; + +export default function jenkinsDocsPage() { + return ( +
+ + +
+ Category: Development + Difficulty: Advanced + Docker image: jenkins/jenkins:lts +
+ +

What is Jenkins?

+

Automation server for CI/CD pipelines

+

Jenkins ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Jenkins, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Jenkins from the Development category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the jenkins/jenkins:lts image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for jenkins.<your-domain>.
      5. +
    5. Wait for the container health check (/login) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "jenkins",
+    "host": "local",
+    "subdomain": "jenkins",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Jenkins on my home host and expose it at jenkins.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Get initial admin password from logs
    2. +
  2. Install suggested plugins
    3. +
  3. Create admin user
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/jenkins/data:/var/jenkins_home
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull jenkins/jenkins:lts every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Jenkins → Update.

+ +

Backups

+

The config volume for Jenkins is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Jenkins:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Jenkins is in the Development category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: jenkins. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/kavita/page.tsx b/src/app/docs/catalog/kavita/page.tsx new file mode 100644 index 0000000..e583f33 --- /dev/null +++ b/src/app/docs/catalog/kavita/page.tsx @@ -0,0 +1,135 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Kavita — DashCaddy Docs', + description: 'Install and configure Kavita via DashCaddy. Digital reading platform for manga, comics, and books', +}; + +export default function kavitaDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: jvmilazz0/kavita:latest +
+ +

What is Kavita?

+

Digital reading platform for manga, comics, and books

+

Kavita ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Kavita, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • A host path to mount as the media library (default: /media/reading).
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Kavita from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the jvmilazz0/kavita:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for kavita.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "kavita",
+    "host": "local",
+    "subdomain": "kavita",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Kavita on my home host and expose it at kavita.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Create admin account on first access
    2. +
  2. Add library folders for manga, comics, or books
    3. +
  3. Supports EPUB, PDF, CBZ, CBR formats
    4. +
+ +

Media library path notes

+

The media mount path you set at deploy time is what Kavita will see as /data. For multi-library setups (movies + TV + music), bind the parent folder and let Kavita discover subfolders automatically.

+
    +
  • Permissions: Kavita runs as a non-root user. Make sure your media files are readable by UID 1000 (or whichever the container expects — check the Logs tab on first run).
    • +
  • Performance: Put the media library on the same storage pool as DashCaddy itself; cross-pool mounts add 10–30% latency on first scan.
    • +
+ + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/kavita/config:/kavita/config
    • +
  • MEDIA_PATH:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull jvmilazz0/kavita:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Kavita → Update.

+ +

Backups

+

The config volume for Kavita is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Kavita:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • +
  • Library shows empty: confirm the media mount path is readable by the container UID and that the directory contains the file extensions Kavita indexes.
    • + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Kavita is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: kavita. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/komga/page.tsx b/src/app/docs/catalog/komga/page.tsx new file mode 100644 index 0000000..5cbc0e2 --- /dev/null +++ b/src/app/docs/catalog/komga/page.tsx @@ -0,0 +1,137 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Komga — DashCaddy Docs', + description: 'Install and configure Komga via DashCaddy. Comic and manga media server with web reader', +}; + +export default function komgaDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: gotson/komga:latest +
+ +

What is Komga?

+

Comic and manga media server with web reader

+

Komga ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Komga, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • A host path to mount as the media library (default: /media/comics).
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Komga from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the gotson/komga:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for komga.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "komga",
+    "host": "local",
+    "subdomain": "komga",
+    "port": "{{PORT}}",
+    "environment": {
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Komga on my home host and expose it at komga.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Create admin account on first access
    2. +
  2. Add your comic libraries (CBZ, CBR, PDF supported)
    3. +
  3. Use OPDS for third-party reader apps
    4. +
+ +

Media library path notes

+

The media mount path you set at deploy time is what Komga will see as /data. For multi-library setups (movies + TV + music), bind the parent folder and let Komga discover subfolders automatically.

+
    +
  • Permissions: Komga runs as a non-root user. Make sure your media files are readable by UID 1000 (or whichever the container expects — check the Logs tab on first run).
    • +
  • Performance: Put the media library on the same storage pool as DashCaddy itself; cross-pool mounts add 10–30% latency on first scan.
    • +
+ + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/komga/config:/config
    • +
  • MEDIA_PATH:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull gotson/komga:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Komga → Update.

+ +

Backups

+

The config volume for Komga is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Komga:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • +
  • Library shows empty: confirm the media mount path is readable by the container UID and that the directory contains the file extensions Komga indexes.
    • + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Komga is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: komga. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/lidarr/page.tsx b/src/app/docs/catalog/lidarr/page.tsx new file mode 100644 index 0000000..557726f --- /dev/null +++ b/src/app/docs/catalog/lidarr/page.tsx @@ -0,0 +1,138 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Lidarr — DashCaddy Docs', + description: 'Install and configure Lidarr via DashCaddy. Music collection manager for Usenet and BitTorrent', +}; + +export default function lidarrDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Intermediate + Docker image: linuxserver/lidarr:latest +
+ +

What is Lidarr?

+

Music collection manager for Usenet and BitTorrent

+

Lidarr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Lidarr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Lidarr from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/lidarr:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for lidarr.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v1/system/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "lidarr",
+    "host": "local",
+    "subdomain": "lidarr",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Lidarr on my home host and expose it at lidarr.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure download clients
    2. +
  2. Add indexers
    3. +
  3. Set up root folders for music
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/lidarr/config:/config
    • +
  • /downloads:/downloads
    • +
  • /music:/music
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/lidarr:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Lidarr → Update.

+ +

Backups

+

The config volume for Lidarr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Lidarr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Lidarr is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: lidarr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/mailserver/page.tsx b/src/app/docs/catalog/mailserver/page.tsx new file mode 100644 index 0000000..93c3b05 --- /dev/null +++ b/src/app/docs/catalog/mailserver/page.tsx @@ -0,0 +1,141 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Docker Mailserver — DashCaddy Docs', + description: 'Install and configure Docker Mailserver via DashCaddy. Full-featured email server with SMTP, IMAP, spam filtering', +}; + +export default function mailserverDocsPage() { + return ( +
+ + +
+ Category: Communication + Difficulty: Advanced + Docker image: mailserver/docker-mailserver:latest +
+ +

What is Docker Mailserver?

+

Full-featured email server with SMTP, IMAP, spam filtering

+

Docker Mailserver ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Docker Mailserver, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Docker Mailserver from the Communication category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the mailserver/docker-mailserver:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for mail.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "mailserver",
+    "host": "local",
+    "subdomain": "mail",
+    "port": "{{PORT}}",
+    "environment": {
+      "ENABLE_SPAMASSASSIN": "",
+      "ENABLE_CLAMAV": "",
+      "ENABLE_FAIL2BAN": "",
+      "ONE_DIR": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Docker Mailserver on my home host and expose it at mail.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure DNS records (MX, SPF, DKIM, DMARC)
    2. +
  2. Create email accounts using setup.sh
    3. +
  3. Set up SSL certificates for secure connections
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/mailserver/data:/var/mail
    • +
  • /opt/mailserver/state:/var/mail-state
    • +
  • /opt/mailserver/logs:/var/log/mail
    • +
  • /opt/mailserver/config:/tmp/docker-mailserver
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • ENABLE_SPAMASSASSIN
    • +
  • ENABLE_CLAMAV
    • +
  • ENABLE_FAIL2BAN
    • +
  • ONE_DIR
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull mailserver/docker-mailserver:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Docker Mailserver → Update.

+ +

Backups

+

The config volume for Docker Mailserver is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Docker Mailserver:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Docker Mailserver is in the Communication category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: mailserver. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/matrix/page.tsx b/src/app/docs/catalog/matrix/page.tsx new file mode 100644 index 0000000..ee7bd42 --- /dev/null +++ b/src/app/docs/catalog/matrix/page.tsx @@ -0,0 +1,132 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Matrix Synapse — DashCaddy Docs', + description: 'Install and configure Matrix Synapse via DashCaddy. Decentralized, secure messaging and collaboration', +}; + +export default function matrixDocsPage() { + return ( +
+ + +
+ Category: Communication + Difficulty: Advanced + Docker image: matrixdotorg/synapse:latest +
+ +

What is Matrix Synapse?

+

Decentralized, secure messaging and collaboration

+

Matrix Synapse ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Matrix Synapse, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Matrix Synapse from the Communication category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the matrixdotorg/synapse:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for matrix.<your-domain>.
      5. +
    5. Wait for the container health check (/_matrix/client/versions) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "matrix",
+    "host": "local",
+    "subdomain": "matrix",
+    "port": "{{PORT}}",
+    "environment": {
+      "SYNAPSE_SERVER_NAME": "",
+      "SYNAPSE_REPORT_STATS": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Matrix Synapse on my home host and expose it at matrix.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Generate initial config with --generate
    2. +
  2. Configure homeserver.yaml
    3. +
  3. Set up federation if needed
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/matrix/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • SYNAPSE_SERVER_NAME
    • +
  • SYNAPSE_REPORT_STATS
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull matrixdotorg/synapse:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Matrix Synapse → Update.

+ +

Backups

+

The config volume for Matrix Synapse is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Matrix Synapse:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Matrix Synapse is in the Communication category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: matrix. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/mealie/page.tsx b/src/app/docs/catalog/mealie/page.tsx new file mode 100644 index 0000000..3669f0c --- /dev/null +++ b/src/app/docs/catalog/mealie/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Mealie — DashCaddy Docs', + description: 'Install and configure Mealie via DashCaddy. Recipe manager and meal planner with grocery lists', +}; + +export default function mealieDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Easy + Docker image: ghcr.io/mealie-recipes/mealie:latest +
+ +

What is Mealie?

+

Recipe manager and meal planner with grocery lists

+

Mealie ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Mealie, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Mealie from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/mealie-recipes/mealie:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for mealie.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "mealie",
+    "host": "local",
+    "subdomain": "mealie",
+    "port": "{{PORT}}",
+    "environment": {
+      "ALLOW_SIGNUP": "",
+      "MAX_WORKERS": "",
+      "WEB_CONCURRENCY": "",
+      "BASE_URL": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Mealie on my home host and expose it at mealie.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Default login: changeme@example.com / MyPassword
    2. +
  2. Import recipes from URLs or add them manually
    3. +
  3. Create meal plans and generate shopping lists
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/mealie/data:/app/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • ALLOW_SIGNUP
    • +
  • MAX_WORKERS
    • +
  • WEB_CONCURRENCY
    • +
  • BASE_URL
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/mealie-recipes/mealie:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Mealie → Update.

+ +

Backups

+

The config volume for Mealie is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Mealie:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Mealie is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: mealie. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/minecraft/page.tsx b/src/app/docs/catalog/minecraft/page.tsx new file mode 100644 index 0000000..4634645 --- /dev/null +++ b/src/app/docs/catalog/minecraft/page.tsx @@ -0,0 +1,141 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Minecraft Server — DashCaddy Docs', + description: 'Install and configure Minecraft Server via DashCaddy. Minecraft Java Edition dedicated server', +}; + +export default function minecraftDocsPage() { + return ( +
+ + +
+ Category: Gaming + Difficulty: Easy + Docker image: itzg/minecraft-server:latest +
+ +

What is Minecraft Server?

+

Minecraft Java Edition dedicated server

+

Minecraft Server ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Minecraft Server, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Minecraft Server from the Gaming category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the itzg/minecraft-server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for mc.<your-domain>.
      5. +
    5. Wait for the container health check (tcp://localhost:25565) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "minecraft",
+    "host": "local",
+    "subdomain": "mc",
+    "port": "{{PORT}}",
+    "environment": {
+      "EULA": "",
+      "TYPE": "",
+      "VERSION": "",
+      "MEMORY": "",
+      "MAX_PLAYERS": "",
+      "MOTD": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Minecraft Server on my home host and expose it at mc.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Server accepts the Minecraft EULA automatically
    2. +
  2. Connect with your Minecraft client to the server IP:port
    3. +
  3. Configure server.properties in the data volume for customization
    4. +
  4. Supports Vanilla, Paper, Forge, Fabric via TYPE environment variable
    5. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/minecraft/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • EULA
    • +
  • TYPE
    • +
  • VERSION
    • +
  • MEMORY
    • +
  • MAX_PLAYERS
    • +
  • MOTD
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull itzg/minecraft-server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Minecraft Server → Update.

+ +

Backups

+

The config volume for Minecraft Server is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Minecraft Server:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Minecraft Server is in the Gaming category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: minecraft. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/mongodb/page.tsx b/src/app/docs/catalog/mongodb/page.tsx new file mode 100644 index 0000000..3fda59c --- /dev/null +++ b/src/app/docs/catalog/mongodb/page.tsx @@ -0,0 +1,132 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install MongoDB — DashCaddy Docs', + description: 'Install and configure MongoDB via DashCaddy. Document-oriented NoSQL database', +}; + +export default function mongodbDocsPage() { + return ( +
+ + +
+ Category: Database + Difficulty: Intermediate + Docker image: mongo:latest +
+ +

What is MongoDB?

+

Document-oriented NoSQL database

+

MongoDB ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using MongoDB, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select MongoDB from the Database category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the mongo:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for mongo.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "mongodb",
+    "host": "local",
+    "subdomain": "mongo",
+    "port": "{{PORT}}",
+    "environment": {
+      "MONGO_INITDB_ROOT_USERNAME": "",
+      "MONGO_INITDB_ROOT_PASSWORD": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy MongoDB on my home host and expose it at mongo.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Change default admin password
    2. +
  2. Create application databases and users
    3. +
  3. Configure replica set if needed
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/mongodb/data:/data/db
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • MONGO_INITDB_ROOT_USERNAME
    • +
  • MONGO_INITDB_ROOT_PASSWORD
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull mongo:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → MongoDB → Update.

+ +

Backups

+

The config volume for MongoDB is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with MongoDB:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

MongoDB is in the Database category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: mongodb. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/navidrome/page.tsx b/src/app/docs/catalog/navidrome/page.tsx new file mode 100644 index 0000000..82ec940 --- /dev/null +++ b/src/app/docs/catalog/navidrome/page.tsx @@ -0,0 +1,133 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Navidrome — DashCaddy Docs', + description: 'Install and configure Navidrome via DashCaddy. Modern music server and streamer', +}; + +export default function navidromeDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: deluan/navidrome:latest +
+ +

What is Navidrome?

+

Modern music server and streamer

+

Navidrome ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Navidrome, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Navidrome from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the deluan/navidrome:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for music.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "navidrome",
+    "host": "local",
+    "subdomain": "music",
+    "port": "{{PORT}}",
+    "environment": {
+      "ND_SCANSCHEDULE": "",
+      "ND_LOGLEVEL": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Navidrome on my home host and expose it at music.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Point to your music library
    2. +
  2. Create user accounts
    3. +
  3. Install Subsonic-compatible apps
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/navidrome/data:/data
    • +
  • /music:/music:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • ND_SCANSCHEDULE
    • +
  • ND_LOGLEVEL
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull deluan/navidrome:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Navidrome → Update.

+ +

Backups

+

The config volume for Navidrome is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Navidrome:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Navidrome is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: navidrome. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/nextcloud/page.tsx b/src/app/docs/catalog/nextcloud/page.tsx new file mode 100644 index 0000000..244ad1e --- /dev/null +++ b/src/app/docs/catalog/nextcloud/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Nextcloud — DashCaddy Docs', + description: 'Install and configure Nextcloud via DashCaddy. Self-hosted productivity platform and file sync', +}; + +export default function nextcloudDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Intermediate + Docker image: nextcloud:latest +
+ +

What is Nextcloud?

+

Self-hosted productivity platform and file sync

+

Nextcloud ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Nextcloud, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Nextcloud from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the nextcloud:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for cloud.<your-domain>.
      5. +
    5. Wait for the container health check (/status.php) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "nextcloud",
+    "host": "local",
+    "subdomain": "cloud",
+    "port": "{{PORT}}",
+    "environment": {
+      "NEXTCLOUD_ADMIN_USER": "",
+      "NEXTCLOUD_ADMIN_PASSWORD": "",
+      "NEXTCLOUD_TRUSTED_DOMAINS": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Nextcloud on my home host and expose it at cloud.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Change the default admin password
    2. +
  2. Configure trusted domains
    3. +
  3. Install recommended apps
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/nextcloud/html:/var/www/html
    • +
  • /opt/nextcloud/data:/var/www/html/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • NEXTCLOUD_ADMIN_USER
    • +
  • NEXTCLOUD_ADMIN_PASSWORD
    • +
  • NEXTCLOUD_TRUSTED_DOMAINS
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull nextcloud:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Nextcloud → Update.

+ +

Backups

+

The config volume for Nextcloud is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Nextcloud:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Nextcloud is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: nextcloud. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/nodered/page.tsx b/src/app/docs/catalog/nodered/page.tsx new file mode 100644 index 0000000..4dcf869 --- /dev/null +++ b/src/app/docs/catalog/nodered/page.tsx @@ -0,0 +1,130 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Node-RED — DashCaddy Docs', + description: 'Install and configure Node-RED via DashCaddy. Flow-based programming for IoT and automation', +}; + +export default function noderedDocsPage() { + return ( +
+ + +
+ Category: Home Automation + Difficulty: Intermediate + Docker image: nodered/node-red:latest +
+ +

What is Node-RED?

+

Flow-based programming for IoT and automation

+

Node-RED ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Node-RED, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Node-RED from the Home Automation category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the nodered/node-red:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for nodered.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "nodered",
+    "host": "local",
+    "subdomain": "nodered",
+    "port": "{{PORT}}",
+    "environment": {
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Node-RED on my home host and expose it at nodered.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Install additional nodes from palette
    2. +
  2. Create flows for automation
    3. +
  3. Connect to Home Assistant or MQTT
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/nodered/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull nodered/node-red:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Node-RED → Update.

+ +

Backups

+

The config volume for Node-RED is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Node-RED:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Node-RED is in the Home Automation category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: nodered. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/nzbget/page.tsx b/src/app/docs/catalog/nzbget/page.tsx new file mode 100644 index 0000000..e222237 --- /dev/null +++ b/src/app/docs/catalog/nzbget/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install NZBGet — DashCaddy Docs', + description: 'Install and configure NZBGet via DashCaddy. Efficient Usenet downloader', +}; + +export default function nzbgetDocsPage() { + return ( +
+ + +
+ Category: Downloads + Difficulty: Intermediate + Docker image: linuxserver/nzbget:latest +
+ +

What is NZBGet?

+

Efficient Usenet downloader

+

NZBGet ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using NZBGet, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select NZBGet from the Downloads category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/nzbget:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for nzbget.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "nzbget",
+    "host": "local",
+    "subdomain": "nzbget",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy NZBGet on my home host and expose it at nzbget.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Default login: nzbget/tegbzn6789
    2. +
  2. Configure news servers
    3. +
  3. Set up categories and paths
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/nzbget/config:/config
    • +
  • /downloads:/downloads
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/nzbget:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → NZBGet → Update.

+ +

Backups

+

The config volume for NZBGet is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with NZBGet:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

NZBGet is in the Downloads category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: nzbget. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/outline/page.tsx b/src/app/docs/catalog/outline/page.tsx new file mode 100644 index 0000000..bbd64c3 --- /dev/null +++ b/src/app/docs/catalog/outline/page.tsx @@ -0,0 +1,134 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Outline — DashCaddy Docs', + description: 'Install and configure Outline via DashCaddy. Modern team knowledge base and wiki', +}; + +export default function outlineDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Advanced + Docker image: outlinewiki/outline:latest +
+ +

What is Outline?

+

Modern team knowledge base and wiki

+

Outline ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Outline, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Outline from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the outlinewiki/outline:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for outline.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "outline",
+    "host": "local",
+    "subdomain": "outline",
+    "port": "{{PORT}}",
+    "environment": {
+      "URL": "",
+      "SECRET_KEY": "",
+      "DATABASE_URL": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Outline on my home host and expose it at outline.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Requires PostgreSQL and Redis
    2. +
  2. Configure OAuth provider
    3. +
  3. Set up S3-compatible storage
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/outline/data:/var/lib/outline/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • URL
    • +
  • SECRET_KEY
    • +
  • DATABASE_URL
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull outlinewiki/outline:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Outline → Update.

+ +

Backups

+

The config volume for Outline is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Outline:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Outline is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: outline. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/page.tsx b/src/app/docs/catalog/page.tsx new file mode 100644 index 0000000..65d3869 --- /dev/null +++ b/src/app/docs/catalog/page.tsx @@ -0,0 +1,638 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'App Catalog — DashCaddy Docs', + description: 'Browse all 77 one-click installable apps supported by DashCaddy, organized by category with install instructions for each.', +}; + +export default function DocsCatalogPage() { + return ( +
+ + +
+

+ 77 apps across 17 categories. New templates are added whenever the upstream Docker image gains traction. The canonical source is dashcaddy-api/src/docker/app-templates.js. +

+
+ +

Media

+
+ +
+

Plex

+ Easy +
+

Stream your personal media collection anywhere

+ + +
+

Jellyfin

+ Easy +
+

Free software media system - alternative to Plex

+ + +
+

Emby

+ Easy +
+

Personal media server with apps for all devices

+ + +
+

Audiobookshelf

+ Easy +
+

Self-hosted audiobook and podcast server

+ + +
+

Navidrome

+ Easy +
+

Modern music server and streamer

+ + +
+

Calibre-Web

+ Intermediate +
+

Web-based ebook manager and reader

+ + +
+

Kavita

+ Easy +
+

Digital reading platform for manga, comics, and books

+ + +
+

Vintage Stereo

+ Easy +
+

Glass-front console stereo that tunes curated real internet stations (SomaFM, KEXP, Radio Paradise, and more) through a beautiful analog UI

+ + +
+

Komga

+ Easy +
+

Comic and manga media server with web reader

+ + +
+

Airsonic Advanced

+ Easy +
+

Free web-based media streamer

+ +
+ +

Media Management

+
+ +
+

Seerr

+ Easy +
+

Media request and discovery manager for Plex, Jellyfin, and Emby

+ + +
+

Sonarr

+ Intermediate +
+

Smart PVR for newsgroup and bittorrent users

+ + +
+

Radarr

+ Intermediate +
+

Movie collection manager for Usenet and BitTorrent

+ + +
+

Tautulli

+ Easy +
+

Plex media server monitoring and statistics

+ + +
+

Prowlarr

+ Advanced +
+

Indexer manager/proxy for *arr applications

+ + +
+

Bazarr

+ Easy +
+

Automatic subtitle downloader for Sonarr and Radarr

+ + +
+

Lidarr

+ Intermediate +
+

Music collection manager for Usenet and BitTorrent

+ + +
+

Readarr

+ Intermediate +
+

Book and audiobook collection manager

+ +
+ +

Downloads

+
+ +
+

qBittorrent

+ Easy +
+

Lightweight BitTorrent client with web UI

+ + +
+

Transmission

+ Easy +
+

Lightweight BitTorrent client

+ + +
+

SABnzbd

+ Intermediate +
+

Binary newsreader for Usenet downloads

+ + +
+

JDownloader 2

+ Easy +
+

Download manager for file hosting sites

+ + +
+

NZBGet

+ Intermediate +
+

Efficient Usenet downloader

+ +
+ +

Productivity

+
+ +
+

Nextcloud

+ Intermediate +
+

Self-hosted productivity platform and file sync

+ + +
+

Paperless-ngx

+ Intermediate +
+

Document management system - scan, organize, and search documents

+ + +
+

BookStack

+ Intermediate +
+

Simple wiki and documentation platform

+ + +
+

Actual Budget

+ Easy +
+

Privacy-focused budgeting app with envelope budgeting

+ + +
+

Mealie

+ Easy +
+

Recipe manager and meal planner with grocery lists

+ + +
+

Outline

+ Advanced +
+

Modern team knowledge base and wiki

+ + +
+

Trilium Notes

+ Easy +
+

Hierarchical knowledge base and note-taking app

+ + +
+

Excalidraw

+ Easy +
+

Collaborative virtual whiteboard for sketching and diagrams

+ + +
+

Standard Notes

+ Intermediate +
+

End-to-end encrypted notes app

+ +
+ +

Development

+
+ +
+

Gitea

+ Easy +
+

Lightweight self-hosted Git service

+ + +
+

VS Code Server

+ Easy +
+

Visual Studio Code in your browser

+ + +
+

Jenkins

+ Advanced +
+

Automation server for CI/CD pipelines

+ + +
+

Drone CI

+ Intermediate +
+

Container-native continuous delivery platform

+ +
+ +

Management

+
+ +
+

Portainer

+ Easy +
+

Docker container management UI

+ + +
+

Watchtower

+ Easy +
+

Automatic Docker container image updates

+ +
+ +

Monitoring

+
+ +
+

Uptime Kuma

+ Easy +
+

Self-hosted monitoring tool like Uptime Robot

+ + +
+

Grafana

+ Advanced +
+

Analytics and interactive visualization platform

+ + +
+

Dozzle

+ Easy +
+

Real-time Docker container log viewer

+ + +
+

Speedtest Tracker

+ Easy +
+

Internet speed monitoring over time

+ +
+ +

Networking

+
+ +
+

Pi-hole

+ Intermediate +
+

Network-wide ad blocker and DNS sinkhole

+ + +
+

WireGuard VPN

+ Advanced +
+

Fast, modern, secure VPN tunnel

+ +
+ +

DNS

+
+ +
+

Technitium DNS Server

+ Easy +
+

Modern DNS server with web UI for managing private zones

+ + +
+

BIND9 DNS Server

+ Advanced +
+

Industry-standard DNS server - powerful and flexible

+ + +
+

PowerDNS

+ Intermediate +
+

High-performance DNS server with SQL backend

+ + +
+

CoreDNS

+ Intermediate +
+

Cloud-native DNS server - lightweight and flexible

+ +
+ +

Files

+
+ +
+

FileBrowser

+ Easy +
+

Web-based file manager with sharing capabilities

+ + +
+

Syncthing

+ Easy +
+

Continuous file synchronization between devices

+ + +
+

Sami Files

+ Intermediate +
+

Multi-server SSH file manager — browse, edit, upload, and exec across all your machines from one browser tab

+ +
+ +

Communication

+
+ +
+

Rocket.Chat

+ Intermediate +
+

Team collaboration platform like Slack

+ + +
+

Matrix Synapse

+ Advanced +
+

Decentralized, secure messaging and collaboration

+ + +
+

Roundcube

+ Intermediate +
+

Modern webmail client with rich features

+ + +
+

Docker Mailserver

+ Advanced +
+

Full-featured email server with SMTP, IMAP, spam filtering

+ +
+ +

Home Automation

+
+ +
+

Home Assistant

+ Intermediate +
+

Open source home automation platform

+ + +
+

Node-RED

+ Intermediate +
+

Flow-based programming for IoT and automation

+ +
+ +

Database

+
+ +
+

PostgreSQL

+ Intermediate +
+

Advanced open-source relational database

+ + +
+

Redis

+ Easy +
+

In-memory data structure store and cache

+ + +
+

MongoDB

+ Intermediate +
+

Document-oriented NoSQL database

+ + +
+

Adminer

+ Easy +
+

Lightweight database management in single PHP file

+ +
+ +

Security

+
+ +
+

DashCA

+ Easy +
+

One-click root CA certificate installer for your network

+ + +
+

Vaultwarden

+ Easy +
+

Lightweight Bitwarden-compatible password manager

+ + +
+

Authentik

+ Advanced +
+

Identity provider and single sign-on platform

+ + +
+

CrowdSec

+ Intermediate +
+

Collaborative intrusion prevention system

+ +
+ +

Photos

+
+ +
+

Immich

+ Intermediate +
+

Self-hosted Google Photos alternative

+ + +
+

PhotoPrism

+ Intermediate +
+

AI-powered photo management

+ +
+ +

Utilities

+
+ +
+

Homepage

+ Easy +
+

Highly customizable application dashboard

+ + +
+

Stirling PDF

+ Easy +
+

Self-hosted PDF manipulation tool - merge, split, convert, and more

+ + +
+

Weather

+ Easy +
+

Live weather widget with temperature, conditions, and wind

+ + +
+

Homarr

+ Easy +
+

Sleek dashboard for all your services

+ + +
+

Digital Clock

+ Easy +
+

Live digital clock with time, date, and day of week

+ + +
+

IT Tools

+ Easy +
+

Collection of handy developer and IT tools in one place

+ + +
+

Change Detection

+ Easy +
+

Monitor websites for changes

+ + +
+

Whoami

+ Easy +
+

Simple HTTP request debugging service

+ +
+ +

Gaming

+
+ +
+

Minecraft Server

+ Easy +
+

Minecraft Java Edition dedicated server

+ + +
+

Valheim Server

+ Easy +
+

Valheim dedicated server for multiplayer Viking adventures

+ +
+ +
+

Adding your own template

+

DashCaddy accepts custom templates via the same REST API used to deploy the built-in ones. Submit a template JSON via POST /api/v1/apps/templates with the schema documented in the API guide, or fork dashcaddy-api/src/docker/app-templates.js and add your template to the catalog for everyone.

+ +
+ ); +} diff --git a/src/app/docs/catalog/paperless-ngx/page.tsx b/src/app/docs/catalog/paperless-ngx/page.tsx new file mode 100644 index 0000000..a7451f8 --- /dev/null +++ b/src/app/docs/catalog/paperless-ngx/page.tsx @@ -0,0 +1,142 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Paperless-ngx — DashCaddy Docs', + description: 'Install and configure Paperless-ngx via DashCaddy. Document management system - scan, organize, and search documents', +}; + +export default function paperlessNgxDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Intermediate + Docker image: ghcr.io/paperless-ngx/paperless-ngx:latest +
+ +

What is Paperless-ngx?

+

Document management system - scan, organize, and search documents

+

Paperless-ngx ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Paperless-ngx, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Paperless-ngx from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/paperless-ngx/paperless-ngx:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for paperless.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "paperless-ngx",
+    "host": "local",
+    "subdomain": "paperless",
+    "port": "{{PORT}}",
+    "environment": {
+      "PAPERLESS_URL": "",
+      "USERMAP_UID": "",
+      "USERMAP_GID": "",
+      "PAPERLESS_TIME_ZONE": "",
+      "PAPERLESS_OCR_LANGUAGE": "",
+      "PAPERLESS_SECRET_KEY": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Paperless-ngx on my home host and expose it at paperless.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Create admin account via: docker exec -it <container> python3 manage.py createsuperuser
    2. +
  2. Drop documents into the consume folder for automatic import
    3. +
  3. Configure tags and correspondents for organization
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/paperless/data:/usr/src/paperless/data
    • +
  • /opt/paperless/media:/usr/src/paperless/media
    • +
  • /opt/paperless/consume:/usr/src/paperless/consume
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PAPERLESS_URL
    • +
  • USERMAP_UID
    • +
  • USERMAP_GID
    • +
  • PAPERLESS_TIME_ZONE
    • +
  • PAPERLESS_OCR_LANGUAGE
    • +
  • PAPERLESS_SECRET_KEY
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/paperless-ngx/paperless-ngx:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Paperless-ngx → Update.

+ +

Backups

+

The config volume for Paperless-ngx is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Paperless-ngx:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Paperless-ngx is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: paperless-ngx. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/photoprism/page.tsx b/src/app/docs/catalog/photoprism/page.tsx new file mode 100644 index 0000000..4b4abc6 --- /dev/null +++ b/src/app/docs/catalog/photoprism/page.tsx @@ -0,0 +1,135 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install PhotoPrism — DashCaddy Docs', + description: 'Install and configure PhotoPrism via DashCaddy. AI-powered photo management', +}; + +export default function photoprismDocsPage() { + return ( +
+ + +
+ Category: Photos + Difficulty: Intermediate + Docker image: photoprism/photoprism:latest +
+ +

What is PhotoPrism?

+

AI-powered photo management

+

PhotoPrism ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using PhotoPrism, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select PhotoPrism from the Photos category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the photoprism/photoprism:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for gallery.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v1/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "photoprism",
+    "host": "local",
+    "subdomain": "gallery",
+    "port": "{{PORT}}",
+    "environment": {
+      "PHOTOPRISM_ADMIN_PASSWORD": "",
+      "PHOTOPRISM_SITE_URL": "",
+      "PHOTOPRISM_DATABASE_DRIVER": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy PhotoPrism on my home host and expose it at gallery.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Change admin password
    2. +
  2. Import your photos
    3. +
  3. Run indexing for AI features
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/photoprism/storage:/photoprism/storage
    • +
  • /opt/photoprism/originals:/photoprism/originals
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PHOTOPRISM_ADMIN_PASSWORD
    • +
  • PHOTOPRISM_SITE_URL
    • +
  • PHOTOPRISM_DATABASE_DRIVER
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull photoprism/photoprism:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → PhotoPrism → Update.

+ +

Backups

+

The config volume for PhotoPrism is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with PhotoPrism:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

PhotoPrism is in the Photos category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: photoprism. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/pihole/page.tsx b/src/app/docs/catalog/pihole/page.tsx new file mode 100644 index 0000000..a37d658 --- /dev/null +++ b/src/app/docs/catalog/pihole/page.tsx @@ -0,0 +1,134 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Pi-hole — DashCaddy Docs', + description: 'Install and configure Pi-hole via DashCaddy. Network-wide ad blocker and DNS sinkhole', +}; + +export default function piholeDocsPage() { + return ( +
+ + +
+ Category: Networking + Difficulty: Intermediate + Docker image: pihole/pihole:latest +
+ +

What is Pi-hole?

+

Network-wide ad blocker and DNS sinkhole

+

Pi-hole ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Pi-hole, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Pi-hole from the Networking category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the pihole/pihole:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for pihole.<your-domain>.
      5. +
    5. Wait for the container health check (/admin/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "pihole",
+    "host": "local",
+    "subdomain": "pihole",
+    "port": "{{PORT}}",
+    "environment": {
+      "WEBPASSWORD": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Pi-hole on my home host and expose it at pihole.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Open the new pihole.<your-domain> URL.
    2. +
  2. Complete the upstream Pi-hole setup wizard (create admin user, accept EULA, etc.).
    3. +
  3. Configure backups from Settings → Backups — the default daily snapshot will capture the data volume.
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/pihole/etc:/etc/pihole
    • +
  • /opt/pihole/dnsmasq:/etc/dnsmasq.d
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • WEBPASSWORD
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull pihole/pihole:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Pi-hole → Update.

+ +

Backups

+

The config volume for Pi-hole is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Pi-hole:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Pi-hole is in the Networking category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: pihole. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/plex/page.tsx b/src/app/docs/catalog/plex/page.tsx new file mode 100644 index 0000000..f65f706 --- /dev/null +++ b/src/app/docs/catalog/plex/page.tsx @@ -0,0 +1,155 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Plex — DashCaddy Docs', + description: 'Install and configure Plex via DashCaddy. Stream your personal media collection anywhere', +}; + +export default function plexDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: plexinc/pms-docker:latest +
+ +

What is Plex?

+

Stream your personal media collection anywhere

+

Plex ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Plex, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • A host path to mount as the media library (default: /media).
    • +
  • A Plex Claim Token — get one from https://plex.tv/claim before you start.
    • +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Plex from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the plexinc/pms-docker:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for plex.<your-domain>.
      5. +
    5. Wait for the container health check (/web/index.html) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "plex",
+    "host": "local",
+    "subdomain": "plex",
+    "port": "{{PORT}}",
+    "environment": {
+      "PLEX_CLAIM": "",
+      "ADVERTISE_IP": "",
+      "PLEX_UID": "",
+      "PLEX_GID": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Plex on my home host and expose it at plex.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Get your claim token from https://plex.tv/claim
    2. +
  2. Add your media libraries in the web interface
    3. +
  3. Configure remote access settings
    4. +
+ +

Media library path notes

+

The media mount path you set at deploy time is what Plex will see as /data. For multi-library setups (movies + TV + music), bind the parent folder and let Plex discover subfolders automatically.

+
    +
  • Permissions: Plex runs as a non-root user. Make sure your media files are readable by UID 1000 (or whichever the container expects — check the Logs tab on first run).
    • +
  • Performance: Put the media library on the same storage pool as DashCaddy itself; cross-pool mounts add 10–30% latency on first scan.
    • +
+ +

Plex Claim Token

+

Get from https://plex.tv/claim - expires in 4 minutes!

+
+

+ Heads up: Plex Claim Token expires after a few minutes. Get a fresh one from + https://plex.tv/claim + right before you click Deploy. +

+
+ +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/plex/config:/config
    • +
  • /opt/plex/transcode:/transcode
    • +
  • MEDIA_PATH:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PLEX_CLAIM
    • +
  • ADVERTISE_IP
    • +
  • PLEX_UID
    • +
  • PLEX_GID
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull plexinc/pms-docker:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Plex → Update.

+ +

Backups

+

The config volume for Plex is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Plex:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • +
  • Library shows empty: confirm the media mount path is readable by the container UID and that the directory contains the file extensions Plex indexes.
    • +
  • Account linking fails: your claim token probably expired. Get a new one and re-deploy.
    • +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Plex is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: plex. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/portainer/page.tsx b/src/app/docs/catalog/portainer/page.tsx new file mode 100644 index 0000000..fd96908 --- /dev/null +++ b/src/app/docs/catalog/portainer/page.tsx @@ -0,0 +1,129 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Portainer — DashCaddy Docs', + description: 'Install and configure Portainer via DashCaddy. Docker container management UI', +}; + +export default function portainerDocsPage() { + return ( +
+ + +
+ Category: Management + Difficulty: Easy + Docker image: portainer/portainer-ce:latest +
+ +

What is Portainer?

+

Docker container management UI

+

Portainer ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Portainer, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Portainer from the Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the portainer/portainer-ce:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for portainer.<your-domain>.
      5. +
    5. Wait for the container health check (/api/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "portainer",
+    "host": "local",
+    "subdomain": "portainer",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Portainer on my home host and expose it at portainer.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Open the new portainer.<your-domain> URL.
    2. +
  2. Complete the upstream Portainer setup wizard (create admin user, accept EULA, etc.).
    3. +
  3. Configure backups from Settings → Backups — the default daily snapshot will capture the data volume.
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /var/run/docker.sock:/var/run/docker.sock
    • +
  • /opt/portainer/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull portainer/portainer-ce:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Portainer → Update.

+ +

Backups

+

The config volume for Portainer is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Portainer:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Portainer is in the Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: portainer. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/postgres/page.tsx b/src/app/docs/catalog/postgres/page.tsx new file mode 100644 index 0000000..48948c5 --- /dev/null +++ b/src/app/docs/catalog/postgres/page.tsx @@ -0,0 +1,134 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install PostgreSQL — DashCaddy Docs', + description: 'Install and configure PostgreSQL via DashCaddy. Advanced open-source relational database', +}; + +export default function postgresDocsPage() { + return ( +
+ + +
+ Category: Database + Difficulty: Intermediate + Docker image: postgres:16-alpine +
+ +

What is PostgreSQL?

+

Advanced open-source relational database

+

PostgreSQL ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using PostgreSQL, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select PostgreSQL from the Database category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the postgres:16-alpine image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for postgres.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "postgres",
+    "host": "local",
+    "subdomain": "postgres",
+    "port": "{{PORT}}",
+    "environment": {
+      "POSTGRES_USER": "",
+      "POSTGRES_PASSWORD": "",
+      "POSTGRES_DB": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy PostgreSQL on my home host and expose it at postgres.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Change default password immediately
    2. +
  2. Create databases and users as needed
    3. +
  3. Configure pg_hba.conf for remote access
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/postgres/data:/var/lib/postgresql/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • POSTGRES_USER
    • +
  • POSTGRES_PASSWORD
    • +
  • POSTGRES_DB
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull postgres:16-alpine every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → PostgreSQL → Update.

+ +

Backups

+

The config volume for PostgreSQL is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with PostgreSQL:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

PostgreSQL is in the Database category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: postgres. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/powerdns/page.tsx b/src/app/docs/catalog/powerdns/page.tsx new file mode 100644 index 0000000..feb586c --- /dev/null +++ b/src/app/docs/catalog/powerdns/page.tsx @@ -0,0 +1,142 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install PowerDNS — DashCaddy Docs', + description: 'Install and configure PowerDNS via DashCaddy. High-performance DNS server with SQL backend', +}; + +export default function powerdnsDocsPage() { + return ( +
+ + +
+ Category: DNS + Difficulty: Intermediate + Docker image: pschiffe/pdns-mysql:latest +
+ +

What is PowerDNS?

+

High-performance DNS server with SQL backend

+

PowerDNS ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using PowerDNS, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select PowerDNS from the DNS category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the pschiffe/pdns-mysql:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for dns3.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v1/servers) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "powerdns",
+    "host": "local",
+    "subdomain": "dns3",
+    "port": "{{PORT}}",
+    "environment": {
+      "PDNS_api": "",
+      "PDNS_api_key": "",
+      "PDNS_webserver": "",
+      "PDNS_webserver_address": "",
+      "PDNS_webserver_allow_from": "",
+      "MYSQL_ROOT_PASSWORD": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy PowerDNS on my home host and expose it at dns3.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Access API at https://dns3.sami:8081
    2. +
  2. Use API key for authentication
    3. +
  3. Create zone via API or PowerDNS Admin
    4. +
  4. Add records for your .sami domain
    5. +
  5. Configure devices to use DNS server
    6. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/powerdns/data:/var/lib/mysql
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PDNS_api
    • +
  • PDNS_api_key
    • +
  • PDNS_webserver
    • +
  • PDNS_webserver_address
    • +
  • PDNS_webserver_allow_from
    • +
  • MYSQL_ROOT_PASSWORD
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull pschiffe/pdns-mysql:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → PowerDNS → Update.

+ +

Backups

+

The config volume for PowerDNS is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with PowerDNS:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

PowerDNS is in the DNS category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: powerdns. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/prowlarr/page.tsx b/src/app/docs/catalog/prowlarr/page.tsx new file mode 100644 index 0000000..fe219d4 --- /dev/null +++ b/src/app/docs/catalog/prowlarr/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Prowlarr — DashCaddy Docs', + description: 'Install and configure Prowlarr via DashCaddy. Indexer manager/proxy for *arr applications', +}; + +export default function prowlarrDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Advanced + Docker image: linuxserver/prowlarr:latest +
+ +

What is Prowlarr?

+

Indexer manager/proxy for *arr applications

+

Prowlarr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Prowlarr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Prowlarr from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/prowlarr:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for prowlarr.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v1/system/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "prowlarr",
+    "host": "local",
+    "subdomain": "prowlarr",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Prowlarr on my home host and expose it at prowlarr.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Open the new prowlarr.<your-domain> URL.
    2. +
  2. Complete the upstream Prowlarr setup wizard (create admin user, accept EULA, etc.).
    3. +
  3. Configure backups from Settings → Backups — the default daily snapshot will capture the data volume.
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/prowlarr/config:/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/prowlarr:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Prowlarr → Update.

+ +

Backups

+

The config volume for Prowlarr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Prowlarr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Prowlarr is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: prowlarr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/qbittorrent/page.tsx b/src/app/docs/catalog/qbittorrent/page.tsx new file mode 100644 index 0000000..5db0832 --- /dev/null +++ b/src/app/docs/catalog/qbittorrent/page.tsx @@ -0,0 +1,138 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install qBittorrent — DashCaddy Docs', + description: 'Install and configure qBittorrent via DashCaddy. Lightweight BitTorrent client with web UI', +}; + +export default function qbittorrentDocsPage() { + return ( +
+ + +
+ Category: Downloads + Difficulty: Easy + Docker image: linuxserver/qbittorrent:latest +
+ +

What is qBittorrent?

+

Lightweight BitTorrent client with web UI

+

qBittorrent ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using qBittorrent, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select qBittorrent from the Downloads category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/qbittorrent:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for torrent.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "qbittorrent",
+    "host": "local",
+    "subdomain": "torrent",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": "",
+      "WEBUI_PORT": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy qBittorrent on my home host and expose it at torrent.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Default login: admin/adminadmin
    2. +
  2. Change default password immediately
    3. +
  3. Configure download paths
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/qbittorrent/config:/config
    • +
  • /downloads:/downloads
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
    • +
  • WEBUI_PORT
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/qbittorrent:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → qBittorrent → Update.

+ +

Backups

+

The config volume for qBittorrent is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with qBittorrent:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

qBittorrent is in the Downloads category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: qbittorrent. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/radarr/page.tsx b/src/app/docs/catalog/radarr/page.tsx new file mode 100644 index 0000000..00c0257 --- /dev/null +++ b/src/app/docs/catalog/radarr/page.tsx @@ -0,0 +1,138 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Radarr — DashCaddy Docs', + description: 'Install and configure Radarr via DashCaddy. Movie collection manager for Usenet and BitTorrent', +}; + +export default function radarrDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Intermediate + Docker image: linuxserver/radarr:latest +
+ +

What is Radarr?

+

Movie collection manager for Usenet and BitTorrent

+

Radarr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Radarr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Radarr from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/radarr:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for radarr.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v3/system/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "radarr",
+    "host": "local",
+    "subdomain": "radarr",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Radarr on my home host and expose it at radarr.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Open the new radarr.<your-domain> URL.
    2. +
  2. Complete the upstream Radarr setup wizard (create admin user, accept EULA, etc.).
    3. +
  3. Configure backups from Settings → Backups — the default daily snapshot will capture the data volume.
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/radarr/config:/config
    • +
  • /downloads:/downloads
    • +
  • /movies:/movies
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/radarr:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Radarr → Update.

+ +

Backups

+

The config volume for Radarr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Radarr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Radarr is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: radarr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/readarr/page.tsx b/src/app/docs/catalog/readarr/page.tsx new file mode 100644 index 0000000..08910d6 --- /dev/null +++ b/src/app/docs/catalog/readarr/page.tsx @@ -0,0 +1,138 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Readarr — DashCaddy Docs', + description: 'Install and configure Readarr via DashCaddy. Book and audiobook collection manager', +}; + +export default function readarrDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Intermediate + Docker image: linuxserver/readarr:develop +
+ +

What is Readarr?

+

Book and audiobook collection manager

+

Readarr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Readarr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Readarr from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/readarr:develop image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for readarr.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v1/system/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "readarr",
+    "host": "local",
+    "subdomain": "readarr",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Readarr on my home host and expose it at readarr.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure download clients
    2. +
  2. Add indexers for books
    3. +
  3. Set up root folders
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/readarr/config:/config
    • +
  • /downloads:/downloads
    • +
  • /books:/books
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/readarr:develop every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Readarr → Update.

+ +

Backups

+

The config volume for Readarr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Readarr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Readarr is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: readarr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/redis/page.tsx b/src/app/docs/catalog/redis/page.tsx new file mode 100644 index 0000000..0989ff0 --- /dev/null +++ b/src/app/docs/catalog/redis/page.tsx @@ -0,0 +1,128 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Redis — DashCaddy Docs', + description: 'Install and configure Redis via DashCaddy. In-memory data structure store and cache', +}; + +export default function redisDocsPage() { + return ( +
+ + +
+ Category: Database + Difficulty: Easy + Docker image: redis:alpine +
+ +

What is Redis?

+

In-memory data structure store and cache

+

Redis ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Redis, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Redis from the Database category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the redis:alpine image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for redis.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "redis",
+    "host": "local",
+    "subdomain": "redis",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Redis on my home host and expose it at redis.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure redis.conf for persistence
    2. +
  2. Set up authentication if needed
    3. +
  3. Configure maxmemory policy
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/redis/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull redis:alpine every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Redis → Update.

+ +

Backups

+

The config volume for Redis is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Redis:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Redis is in the Database category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: redis. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/rocketchat/page.tsx b/src/app/docs/catalog/rocketchat/page.tsx new file mode 100644 index 0000000..b5d06c3 --- /dev/null +++ b/src/app/docs/catalog/rocketchat/page.tsx @@ -0,0 +1,132 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Rocket.Chat — DashCaddy Docs', + description: 'Install and configure Rocket.Chat via DashCaddy. Team collaboration platform like Slack', +}; + +export default function rocketchatDocsPage() { + return ( +
+ + +
+ Category: Communication + Difficulty: Intermediate + Docker image: rocket.chat:latest +
+ +

What is Rocket.Chat?

+

Team collaboration platform like Slack

+

Rocket.Chat ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Rocket.Chat, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Rocket.Chat from the Communication category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the rocket.chat:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for chat.<your-domain>.
      5. +
    5. Wait for the container health check (/api/info) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "rocketchat",
+    "host": "local",
+    "subdomain": "chat",
+    "port": "{{PORT}}",
+    "environment": {
+      "ROOT_URL": "",
+      "MONGO_URL": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Rocket.Chat on my home host and expose it at chat.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Requires MongoDB - deploy mongo container first
    2. +
  2. Complete admin setup wizard
    3. +
  3. Configure OAuth and integrations
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/rocketchat/uploads:/app/uploads
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • ROOT_URL
    • +
  • MONGO_URL
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull rocket.chat:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Rocket.Chat → Update.

+ +

Backups

+

The config volume for Rocket.Chat is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Rocket.Chat:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Rocket.Chat is in the Communication category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: rocketchat. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/roundcube/page.tsx b/src/app/docs/catalog/roundcube/page.tsx new file mode 100644 index 0000000..a3c3496 --- /dev/null +++ b/src/app/docs/catalog/roundcube/page.tsx @@ -0,0 +1,133 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Roundcube — DashCaddy Docs', + description: 'Install and configure Roundcube via DashCaddy. Modern webmail client with rich features', +}; + +export default function roundcubeDocsPage() { + return ( +
+ + +
+ Category: Communication + Difficulty: Intermediate + Docker image: roundcube/roundcubemail:latest +
+ +

What is Roundcube?

+

Modern webmail client with rich features

+

Roundcube ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Roundcube, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Roundcube from the Communication category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the roundcube/roundcubemail:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for webmail.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "roundcube",
+    "host": "local",
+    "subdomain": "webmail",
+    "port": "{{PORT}}",
+    "environment": {
+      "ROUNDCUBEMAIL_DEFAULT_HOST": "",
+      "ROUNDCUBEMAIL_SMTP_SERVER": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Roundcube on my home host and expose it at webmail.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure IMAP/SMTP server settings
    2. +
  2. Set up database connection
    3. +
  3. Customize appearance and plugins
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/roundcube/config:/var/roundcube/config
    • +
  • /opt/roundcube/db:/var/roundcube/db
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • ROUNDCUBEMAIL_DEFAULT_HOST
    • +
  • ROUNDCUBEMAIL_SMTP_SERVER
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull roundcube/roundcubemail:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Roundcube → Update.

+ +

Backups

+

The config volume for Roundcube is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Roundcube:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Roundcube is in the Communication category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: roundcube. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/sabnzbd/page.tsx b/src/app/docs/catalog/sabnzbd/page.tsx new file mode 100644 index 0000000..487b607 --- /dev/null +++ b/src/app/docs/catalog/sabnzbd/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install SABnzbd — DashCaddy Docs', + description: 'Install and configure SABnzbd via DashCaddy. Binary newsreader for Usenet downloads', +}; + +export default function sabnzbdDocsPage() { + return ( +
+ + +
+ Category: Downloads + Difficulty: Intermediate + Docker image: linuxserver/sabnzbd:latest +
+ +

What is SABnzbd?

+

Binary newsreader for Usenet downloads

+

SABnzbd ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using SABnzbd, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select SABnzbd from the Downloads category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/sabnzbd:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for sabnzbd.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "sabnzbd",
+    "host": "local",
+    "subdomain": "sabnzbd",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy SABnzbd on my home host and expose it at sabnzbd.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure Usenet server credentials
    2. +
  2. Set up download categories
    3. +
  3. Configure post-processing scripts
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/sabnzbd/config:/config
    • +
  • /downloads:/downloads
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/sabnzbd:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → SABnzbd → Update.

+ +

Backups

+

The config volume for SABnzbd is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with SABnzbd:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

SABnzbd is in the Downloads category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: sabnzbd. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/sami-files/page.tsx b/src/app/docs/catalog/sami-files/page.tsx new file mode 100644 index 0000000..380223e --- /dev/null +++ b/src/app/docs/catalog/sami-files/page.tsx @@ -0,0 +1,133 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Sami Files — DashCaddy Docs', + description: 'Install and configure Sami Files via DashCaddy. Multi-server SSH file manager — browse, edit, upload, and exec across all your machines from one browser tab', +}; + +export default function samiFilesDocsPage() { + return ( +
+ + +
+ Category: Files + Difficulty: Intermediate + Docker image: N/A +
+ +

What is Sami Files?

+

Multi-server SSH file manager — browse, edit, upload, and exec across all your machines from one browser tab

+

Sami Files ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Sami Files, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Sami Files from the Files category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the N/A image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for files.<your-domain>.
      5. +
    5. Wait for the container health check (http://127.0.0.1:8765/api/health) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "sami-files",
+    "host": "local",
+    "subdomain": "files",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Sami Files on my home host and expose it at files.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Clone the repo: git clone http://100.81.59.99:3030/sami7777/sami-files.git /opt/sami-files
    2. +
  2. Create venv and install deps: /usr/local/lib/hermes-agent/venv/bin/pip install fastapi uvicorn asyncssh pyyaml python-multipart
    3. +
  3. Copy deploy/sami-files.service to /etc/systemd/system/ and `systemctl daemon-reload`
    4. +
  4. Enable + start: systemctl enable --now sami-files.service
    5. +
  5. Edit /opt/sami-files/config/servers.yaml to add your SSH targets
    6. +
  6. Add the Caddy snippet (above) to your Caddyfile and reload Caddy
    7. +
  7. Mount the log dir into DashCaddy: add `-v /opt/sami-files/logs:/opt/sami-files/logs:ro` to start.sh, then recreate the container
    8. +
  8. Browse to https://files.sami — log in via DashCaddy SSO
    9. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    + +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull N/A every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Sami Files → Update.

+ +

Backups

+

The config volume for Sami Files is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Sami Files:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Sami Files is in the Files category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: sami-files. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/seerr/page.tsx b/src/app/docs/catalog/seerr/page.tsx new file mode 100644 index 0000000..54c2d01 --- /dev/null +++ b/src/app/docs/catalog/seerr/page.tsx @@ -0,0 +1,132 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Seerr — DashCaddy Docs', + description: 'Install and configure Seerr via DashCaddy. Media request and discovery manager for Plex, Jellyfin, and Emby', +}; + +export default function seerrDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Easy + Docker image: ghcr.io/seerr-team/seerr:latest +
+ +

What is Seerr?

+

Media request and discovery manager for Plex, Jellyfin, and Emby

+

Seerr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Seerr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Seerr from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/seerr-team/seerr:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for requests.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v1/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "seerr",
+    "host": "local",
+    "subdomain": "requests",
+    "port": "{{PORT}}",
+    "environment": {
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Seerr on my home host and expose it at requests.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Connect to Plex, Jellyfin, or Emby server
    2. +
  2. Link Sonarr and Radarr
    3. +
  3. Configure user permissions
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/seerr/config:/app/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/seerr-team/seerr:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Seerr → Update.

+ +

Backups

+

The config volume for Seerr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Seerr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Seerr is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: seerr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/sonarr/page.tsx b/src/app/docs/catalog/sonarr/page.tsx new file mode 100644 index 0000000..8cb36fb --- /dev/null +++ b/src/app/docs/catalog/sonarr/page.tsx @@ -0,0 +1,138 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Sonarr — DashCaddy Docs', + description: 'Install and configure Sonarr via DashCaddy. Smart PVR for newsgroup and bittorrent users', +}; + +export default function sonarrDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Intermediate + Docker image: linuxserver/sonarr:latest +
+ +

What is Sonarr?

+

Smart PVR for newsgroup and bittorrent users

+

Sonarr ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Sonarr, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Sonarr from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/sonarr:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for sonarr.<your-domain>.
      5. +
    5. Wait for the container health check (/api/v3/system/status) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "sonarr",
+    "host": "local",
+    "subdomain": "sonarr",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Sonarr on my home host and expose it at sonarr.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure download clients (qBittorrent, etc.)
    2. +
  2. Add indexers for content discovery
    3. +
  3. Set up root folders for TV shows
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/sonarr/config:/config
    • +
  • /downloads:/downloads
    • +
  • /tv:/tv
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/sonarr:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Sonarr → Update.

+ +

Backups

+

The config volume for Sonarr is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Sonarr:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Sonarr is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: sonarr. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/speedtest/page.tsx b/src/app/docs/catalog/speedtest/page.tsx new file mode 100644 index 0000000..8c453ac --- /dev/null +++ b/src/app/docs/catalog/speedtest/page.tsx @@ -0,0 +1,135 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Speedtest Tracker — DashCaddy Docs', + description: 'Install and configure Speedtest Tracker via DashCaddy. Internet speed monitoring over time', +}; + +export default function speedtestDocsPage() { + return ( +
+ + +
+ Category: Monitoring + Difficulty: Easy + Docker image: ghcr.io/alexjustesen/speedtest-tracker:latest +
+ +

What is Speedtest Tracker?

+

Internet speed monitoring over time

+

Speedtest Tracker ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Speedtest Tracker, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Speedtest Tracker from the Monitoring category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the ghcr.io/alexjustesen/speedtest-tracker:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for speedtest.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "speedtest",
+    "host": "local",
+    "subdomain": "speedtest",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "DB_CONNECTION": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Speedtest Tracker on my home host and expose it at speedtest.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure test schedule
    2. +
  2. View historical data
    3. +
  3. Set up notifications for slow speeds
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/speedtest/config:/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • DB_CONNECTION
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull ghcr.io/alexjustesen/speedtest-tracker:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Speedtest Tracker → Update.

+ +

Backups

+

The config volume for Speedtest Tracker is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Speedtest Tracker:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Speedtest Tracker is in the Monitoring category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: speedtest. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/standardnotes/page.tsx b/src/app/docs/catalog/standardnotes/page.tsx new file mode 100644 index 0000000..bc4b28b --- /dev/null +++ b/src/app/docs/catalog/standardnotes/page.tsx @@ -0,0 +1,130 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Standard Notes — DashCaddy Docs', + description: 'Install and configure Standard Notes via DashCaddy. End-to-end encrypted notes app', +}; + +export default function standardnotesDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Intermediate + Docker image: standardnotes/server:latest +
+ +

What is Standard Notes?

+

End-to-end encrypted notes app

+

Standard Notes ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Standard Notes, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Standard Notes from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the standardnotes/server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for notes.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "standardnotes",
+    "host": "local",
+    "subdomain": "notes",
+    "port": "{{PORT}}",
+    "environment": {
+      "RAILS_ENV": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Standard Notes on my home host and expose it at notes.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure environment variables
    2. +
  2. Set up database connection
    3. +
  3. Install Standard Notes apps
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/standardnotes/data:/var/lib/server
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • RAILS_ENV
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull standardnotes/server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Standard Notes → Update.

+ +

Backups

+

The config volume for Standard Notes is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Standard Notes:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Standard Notes is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: standardnotes. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/stirling-pdf/page.tsx b/src/app/docs/catalog/stirling-pdf/page.tsx new file mode 100644 index 0000000..cd554fa --- /dev/null +++ b/src/app/docs/catalog/stirling-pdf/page.tsx @@ -0,0 +1,131 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Stirling PDF — DashCaddy Docs', + description: 'Install and configure Stirling PDF via DashCaddy. Self-hosted PDF manipulation tool - merge, split, convert, and more', +}; + +export default function stirlingPdfDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: frooodle/s-pdf:latest +
+ +

What is Stirling PDF?

+

Self-hosted PDF manipulation tool - merge, split, convert, and more

+

Stirling PDF ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Stirling PDF, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Stirling PDF from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the frooodle/s-pdf:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for pdf.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "stirling-pdf",
+    "host": "local",
+    "subdomain": "pdf",
+    "port": "{{PORT}}",
+    "environment": {
+      "DOCKER_ENABLE_SECURITY": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Stirling PDF on my home host and expose it at pdf.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Access the web interface to start manipulating PDFs
    2. +
  2. Supports merge, split, rotate, convert, compress, and more
    3. +
  3. Optional OCR support via Tesseract
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/stirling-pdf/data:/usr/share/tessdata
    • +
  • /opt/stirling-pdf/config:/configs
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • DOCKER_ENABLE_SECURITY
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull frooodle/s-pdf:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Stirling PDF → Update.

+ +

Backups

+

The config volume for Stirling PDF is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Stirling PDF:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Stirling PDF is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: stirling-pdf. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/syncthing/page.tsx b/src/app/docs/catalog/syncthing/page.tsx new file mode 100644 index 0000000..eec7a99 --- /dev/null +++ b/src/app/docs/catalog/syncthing/page.tsx @@ -0,0 +1,135 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Syncthing — DashCaddy Docs', + description: 'Install and configure Syncthing via DashCaddy. Continuous file synchronization between devices', +}; + +export default function syncthingDocsPage() { + return ( +
+ + +
+ Category: Files + Difficulty: Easy + Docker image: linuxserver/syncthing:latest +
+ +

What is Syncthing?

+

Continuous file synchronization between devices

+

Syncthing ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Syncthing, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Syncthing from the Files category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/syncthing:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for sync.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "syncthing",
+    "host": "local",
+    "subdomain": "sync",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Syncthing on my home host and expose it at sync.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Add devices using their Device IDs
    2. +
  2. Configure shared folders
    3. +
  3. Set up folder synchronization
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/syncthing/config:/config
    • +
  • /opt/syncthing/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/syncthing:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Syncthing → Update.

+ +

Backups

+

The config volume for Syncthing is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Syncthing:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Syncthing is in the Files category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: syncthing. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/tautulli/page.tsx b/src/app/docs/catalog/tautulli/page.tsx new file mode 100644 index 0000000..06662ca --- /dev/null +++ b/src/app/docs/catalog/tautulli/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Tautulli — DashCaddy Docs', + description: 'Install and configure Tautulli via DashCaddy. Plex media server monitoring and statistics', +}; + +export default function tautulliDocsPage() { + return ( +
+ + +
+ Category: Media Management + Difficulty: Easy + Docker image: linuxserver/tautulli:latest +
+ +

What is Tautulli?

+

Plex media server monitoring and statistics

+

Tautulli ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Tautulli, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Tautulli from the Media Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/tautulli:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for tautulli.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "tautulli",
+    "host": "local",
+    "subdomain": "tautulli",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Tautulli on my home host and expose it at tautulli.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Connect to Plex server
    2. +
  2. Configure notifications
    3. +
  3. Set up newsletters
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/tautulli/config:/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/tautulli:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Tautulli → Update.

+ +

Backups

+

The config volume for Tautulli is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Tautulli:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Tautulli is in the Media Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: tautulli. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/technitium/page.tsx b/src/app/docs/catalog/technitium/page.tsx new file mode 100644 index 0000000..774e9ea --- /dev/null +++ b/src/app/docs/catalog/technitium/page.tsx @@ -0,0 +1,134 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Technitium DNS Server — DashCaddy Docs', + description: 'Install and configure Technitium DNS Server via DashCaddy. Modern DNS server with web UI for managing private zones', +}; + +export default function technitiumDocsPage() { + return ( +
+ + +
+ Category: DNS + Difficulty: Easy + Docker image: technitium/dns-server:latest +
+ +

What is Technitium DNS Server?

+

Modern DNS server with web UI for managing private zones

+

Technitium DNS Server ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Technitium DNS Server, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Technitium DNS Server from the DNS category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the technitium/dns-server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for dns1.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "technitium",
+    "host": "local",
+    "subdomain": "dns1",
+    "port": "{{PORT}}",
+    "environment": {
+      "DNS_SERVER_DOMAIN": "",
+      "DNS_SERVER_ADMIN_PASSWORD": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Technitium DNS Server on my home host and expose it at dns1.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Access web interface at https://dns1.sami
    2. +
  2. Login with admin credentials
    3. +
  3. Create a primary zone for 'sami' domain
    4. +
  4. Add A records for your services (e.g., plex.sami -> 192.168.1.100)
    5. +
  5. Configure your devices to use this DNS server
    6. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/technitium/config:/etc/dns
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • DNS_SERVER_DOMAIN
    • +
  • DNS_SERVER_ADMIN_PASSWORD
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull technitium/dns-server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Technitium DNS Server → Update.

+ +

Backups

+

The config volume for Technitium DNS Server is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Technitium DNS Server:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Technitium DNS Server is in the DNS category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: technitium. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/transmission/page.tsx b/src/app/docs/catalog/transmission/page.tsx new file mode 100644 index 0000000..3d84e82 --- /dev/null +++ b/src/app/docs/catalog/transmission/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Transmission — DashCaddy Docs', + description: 'Install and configure Transmission via DashCaddy. Lightweight BitTorrent client', +}; + +export default function transmissionDocsPage() { + return ( +
+ + +
+ Category: Downloads + Difficulty: Easy + Docker image: linuxserver/transmission:latest +
+ +

What is Transmission?

+

Lightweight BitTorrent client

+

Transmission ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Transmission, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Transmission from the Downloads category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/transmission:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for transmission.<your-domain>.
      5. +
    5. Wait for the container health check (/transmission/web/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "transmission",
+    "host": "local",
+    "subdomain": "transmission",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Transmission on my home host and expose it at transmission.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure download paths
    2. +
  2. Set bandwidth limits
    3. +
  3. Configure blocklists if needed
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/transmission/config:/config
    • +
  • /downloads:/downloads
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/transmission:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Transmission → Update.

+ +

Backups

+

The config volume for Transmission is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Transmission:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Transmission is in the Downloads category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: transmission. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/trilium/page.tsx b/src/app/docs/catalog/trilium/page.tsx new file mode 100644 index 0000000..f6f1a06 --- /dev/null +++ b/src/app/docs/catalog/trilium/page.tsx @@ -0,0 +1,128 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Trilium Notes — DashCaddy Docs', + description: 'Install and configure Trilium Notes via DashCaddy. Hierarchical knowledge base and note-taking app', +}; + +export default function triliumDocsPage() { + return ( +
+ + +
+ Category: Productivity + Difficulty: Easy + Docker image: zadam/trilium:latest +
+ +

What is Trilium Notes?

+

Hierarchical knowledge base and note-taking app

+

Trilium Notes ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Trilium Notes, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Trilium Notes from the Productivity category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the zadam/trilium:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for notes.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "trilium",
+    "host": "local",
+    "subdomain": "notes",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Trilium Notes on my home host and expose it at notes.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Set your password on first access
    2. +
  2. Organize notes in a tree hierarchy
    3. +
  3. Supports rich text, code blocks, math equations, and diagrams
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/trilium/data:/home/node/trilium-data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull zadam/trilium:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Trilium Notes → Update.

+ +

Backups

+

The config volume for Trilium Notes is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Trilium Notes:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Trilium Notes is in the Productivity category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: trilium. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/uptime-kuma/page.tsx b/src/app/docs/catalog/uptime-kuma/page.tsx new file mode 100644 index 0000000..07c7752 --- /dev/null +++ b/src/app/docs/catalog/uptime-kuma/page.tsx @@ -0,0 +1,129 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Uptime Kuma — DashCaddy Docs', + description: 'Install and configure Uptime Kuma via DashCaddy. Self-hosted monitoring tool like Uptime Robot', +}; + +export default function uptimeKumaDocsPage() { + return ( +
+ + +
+ Category: Monitoring + Difficulty: Easy + Docker image: louislam/uptime-kuma:latest +
+ +

What is Uptime Kuma?

+

Self-hosted monitoring tool like Uptime Robot

+

Uptime Kuma ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Uptime Kuma, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Uptime Kuma from the Monitoring category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the louislam/uptime-kuma:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for uptime.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "uptime-kuma",
+    "host": "local",
+    "subdomain": "uptime",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Uptime Kuma on my home host and expose it at uptime.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Open the new uptime.<your-domain> URL.
    2. +
  2. Complete the upstream Uptime Kuma setup wizard (create admin user, accept EULA, etc.).
    3. +
  3. Configure backups from Settings → Backups — the default daily snapshot will capture the data volume.
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/uptime-kuma:/app/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull louislam/uptime-kuma:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Uptime Kuma → Update.

+ +

Backups

+

The config volume for Uptime Kuma is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Uptime Kuma:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Uptime Kuma is in the Monitoring category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: uptime-kuma. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/valheim/page.tsx b/src/app/docs/catalog/valheim/page.tsx new file mode 100644 index 0000000..aa967a3 --- /dev/null +++ b/src/app/docs/catalog/valheim/page.tsx @@ -0,0 +1,138 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Valheim Server — DashCaddy Docs', + description: 'Install and configure Valheim Server via DashCaddy. Valheim dedicated server for multiplayer Viking adventures', +}; + +export default function valheimDocsPage() { + return ( +
+ + +
+ Category: Gaming + Difficulty: Easy + Docker image: lloesche/valheim-server:latest +
+ +

What is Valheim Server?

+

Valheim dedicated server for multiplayer Viking adventures

+

Valheim Server ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Valheim Server, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Valheim Server from the Gaming category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the lloesche/valheim-server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for valheim.<your-domain>.
      5. +
    5. Wait for the container health check (tcp://localhost:2456) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "valheim",
+    "host": "local",
+    "subdomain": "valheim",
+    "port": "{{PORT}}",
+    "environment": {
+      "SERVER_NAME": "",
+      "WORLD_NAME": "",
+      "SERVER_PASS": "",
+      "SERVER_PUBLIC": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Valheim Server on my home host and expose it at valheim.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Connect via Steam: Add Server > IP:2456
    2. +
  2. Default server password is auto-generated (check environment variables)
    3. +
  3. World data is persisted in the data volume
    4. +
  4. Requires at least 4GB RAM for smooth operation
    5. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/valheim/config:/config
    • +
  • /opt/valheim/data:/opt/valheim
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • SERVER_NAME
    • +
  • WORLD_NAME
    • +
  • SERVER_PASS
    • +
  • SERVER_PUBLIC
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull lloesche/valheim-server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Valheim Server → Update.

+ +

Backups

+

The config volume for Valheim Server is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Valheim Server:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Valheim Server is in the Gaming category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: valheim. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/vaultwarden/page.tsx b/src/app/docs/catalog/vaultwarden/page.tsx new file mode 100644 index 0000000..1c092a0 --- /dev/null +++ b/src/app/docs/catalog/vaultwarden/page.tsx @@ -0,0 +1,133 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Vaultwarden — DashCaddy Docs', + description: 'Install and configure Vaultwarden via DashCaddy. Lightweight Bitwarden-compatible password manager', +}; + +export default function vaultwardenDocsPage() { + return ( +
+ + +
+ Category: Security + Difficulty: Easy + Docker image: vaultwarden/server:latest +
+ +

What is Vaultwarden?

+

Lightweight Bitwarden-compatible password manager

+

Vaultwarden ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Vaultwarden, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Vaultwarden from the Security category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the vaultwarden/server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for vault.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "vaultwarden",
+    "host": "local",
+    "subdomain": "vault",
+    "port": "{{PORT}}",
+    "environment": {
+      "DOMAIN": "",
+      "ADMIN_TOKEN": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Vaultwarden on my home host and expose it at vault.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Change admin token immediately
    2. +
  2. Create your account
    3. +
  3. Install browser extensions and mobile apps
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/vaultwarden/data:/data
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • DOMAIN
    • +
  • ADMIN_TOKEN
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull vaultwarden/server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Vaultwarden → Update.

+ +

Backups

+

The config volume for Vaultwarden is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Vaultwarden:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Vaultwarden is in the Security category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: vaultwarden. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/vintage-radio/page.tsx b/src/app/docs/catalog/vintage-radio/page.tsx new file mode 100644 index 0000000..caa1efd --- /dev/null +++ b/src/app/docs/catalog/vintage-radio/page.tsx @@ -0,0 +1,130 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Vintage Stereo — DashCaddy Docs', + description: 'Install and configure Vintage Stereo via DashCaddy. Glass-front console stereo that tunes curated real internet stations (SomaFM, KEXP, Radio Paradise, and more) through a beautiful analog UI', +}; + +export default function vintageRadioDocsPage() { + return ( +
+ + +
+ Category: Media + Difficulty: Easy + Docker image: nginx:alpine +
+ +

What is Vintage Stereo?

+

Glass-front console stereo that tunes curated real internet stations (SomaFM, KEXP, Radio Paradise, and more) through a beautiful analog UI

+

Vintage Stereo ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Vintage Stereo, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Vintage Stereo from the Media category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the nginx:alpine image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for radio.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "vintage-radio",
+    "host": "local",
+    "subdomain": "radio",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Vintage Stereo on my home host and expose it at radio.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Run `bash /usr/local/bin/vintage-radio-install.sh` once before starting the container — copies the bundled web assets (index.html, radio.css, radio.js, stations.json) from the DashCaddy repo (dashcaddy-api/static-sites/vintage-radio/web) into /opt/vintage-radio/web
    2. +
  2. Open radio.sami (or your configured subdomain)
    3. +
  3. Press the PWR knob, drag the dial or click a station card
    4. +
  4. Cycle the MODE knob to filter by genre (ALL / AMBIENT / ROCK / MIXED)
    5. +
  5. To add stations, edit /opt/vintage-radio/web/stations.json on the host and restart the container
    6. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/vintage-radio/web:/usr/share/nginx/html:ro
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull nginx:alpine every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Vintage Stereo → Update.

+ +

Backups

+

The config volume for Vintage Stereo is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Vintage Stereo:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Vintage Stereo is in the Media category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: vintage-radio. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/vscode-server/page.tsx b/src/app/docs/catalog/vscode-server/page.tsx new file mode 100644 index 0000000..337d460 --- /dev/null +++ b/src/app/docs/catalog/vscode-server/page.tsx @@ -0,0 +1,131 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install VS Code Server — DashCaddy Docs', + description: 'Install and configure VS Code Server via DashCaddy. Visual Studio Code in your browser', +}; + +export default function vscodeServerDocsPage() { + return ( +
+ + +
+ Category: Development + Difficulty: Easy + Docker image: codercom/code-server:latest +
+ +

What is VS Code Server?

+

Visual Studio Code in your browser

+

VS Code Server ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using VS Code Server, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select VS Code Server from the Development category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the codercom/code-server:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for code.<your-domain>.
      5. +
    5. Wait for the container health check (/healthz) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "vscode-server",
+    "host": "local",
+    "subdomain": "code",
+    "port": "{{PORT}}",
+    "environment": {
+      "PASSWORD": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy VS Code Server on my home host and expose it at code.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Open the new code.<your-domain> URL.
    2. +
  2. Complete the upstream VS Code Server setup wizard (create admin user, accept EULA, etc.).
    3. +
  3. Configure backups from Settings → Backups — the default daily snapshot will capture the data volume.
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/vscode/config:/home/coder/.config
    • +
  • /opt/vscode/projects:/home/coder/projects
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PASSWORD
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull codercom/code-server:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → VS Code Server → Update.

+ +

Backups

+

The config volume for VS Code Server is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with VS Code Server:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

VS Code Server is in the Development category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: vscode-server. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/watchtower/page.tsx b/src/app/docs/catalog/watchtower/page.tsx new file mode 100644 index 0000000..685f8ce --- /dev/null +++ b/src/app/docs/catalog/watchtower/page.tsx @@ -0,0 +1,136 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Watchtower — DashCaddy Docs', + description: 'Install and configure Watchtower via DashCaddy. Automatic Docker container image updates', +}; + +export default function watchtowerDocsPage() { + return ( +
+ + +
+ Category: Management + Difficulty: Easy + Docker image: containrrr/watchtower:latest +
+ +

What is Watchtower?

+

Automatic Docker container image updates

+

Watchtower ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Watchtower, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Watchtower from the Management category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the containrrr/watchtower:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for watchtower.<your-domain>.
      5. +
    5. Wait for the container health check (/v1/update) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "watchtower",
+    "host": "local",
+    "subdomain": "watchtower",
+    "port": "{{PORT}}",
+    "environment": {
+      "WATCHTOWER_CLEANUP": "",
+      "WATCHTOWER_SCHEDULE": "",
+      "WATCHTOWER_HTTP_API_METRICS": "",
+      "WATCHTOWER_HTTP_API_TOKEN": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Watchtower on my home host and expose it at watchtower.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Watchtower checks for image updates daily at 4 AM by default
    2. +
  2. Customize schedule via WATCHTOWER_SCHEDULE (cron format)
    3. +
  3. Add labels to exclude specific containers from updates
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /var/run/docker.sock:/var/run/docker.sock
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • WATCHTOWER_CLEANUP
    • +
  • WATCHTOWER_SCHEDULE
    • +
  • WATCHTOWER_HTTP_API_METRICS
    • +
  • WATCHTOWER_HTTP_API_TOKEN
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull containrrr/watchtower:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Watchtower → Update.

+ +

Backups

+

The config volume for Watchtower is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Watchtower:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Watchtower is in the Management category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: watchtower. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/weather/page.tsx b/src/app/docs/catalog/weather/page.tsx new file mode 100644 index 0000000..ac22799 --- /dev/null +++ b/src/app/docs/catalog/weather/page.tsx @@ -0,0 +1,127 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Weather — DashCaddy Docs', + description: 'Install and configure Weather via DashCaddy. Live weather widget with temperature, conditions, and wind', +}; + +export default function weatherDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: N/A +
+ +

What is Weather?

+

Live weather widget with temperature, conditions, and wind

+

Weather ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Weather, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Weather from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the N/A image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for weather.<your-domain>.
      5. +
    5. Wait for the container health check (/healthz) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "weather",
+    "host": "local",
+    "subdomain": "weather",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Weather on my home host and expose it at weather.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Click the gear icon on the widget to set your ZIP code
    2. +
  2. Weather appears in the top bar next to the logo
    3. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    + +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull N/A every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Weather → Update.

+ +

Backups

+

The config volume for Weather is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Weather:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Weather is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: weather. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/whoami/page.tsx b/src/app/docs/catalog/whoami/page.tsx new file mode 100644 index 0000000..76b88cb --- /dev/null +++ b/src/app/docs/catalog/whoami/page.tsx @@ -0,0 +1,127 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install Whoami — DashCaddy Docs', + description: 'Install and configure Whoami via DashCaddy. Simple HTTP request debugging service', +}; + +export default function whoamiDocsPage() { + return ( +
+ + +
+ Category: Utilities + Difficulty: Easy + Docker image: traefik/whoami:latest +
+ +

What is Whoami?

+

Simple HTTP request debugging service

+

Whoami ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using Whoami, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select Whoami from the Utilities category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the traefik/whoami:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for whoami.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "whoami",
+    "host": "local",
+    "subdomain": "whoami",
+    "port": "{{PORT}}",
+    
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy Whoami on my home host and expose it at whoami.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Useful for testing reverse proxy setup
    2. +
  2. Shows request headers and info
    3. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/whoami/config:/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+

None. The container runs with its upstream defaults.

+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull traefik/whoami:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → Whoami → Update.

+ +

Backups

+

The config volume for Whoami is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with Whoami:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

Whoami is in the Utilities category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: whoami. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/app/docs/catalog/wireguard/page.tsx b/src/app/docs/catalog/wireguard/page.tsx new file mode 100644 index 0000000..51d2a2a --- /dev/null +++ b/src/app/docs/catalog/wireguard/page.tsx @@ -0,0 +1,141 @@ +import Navbar from '@/components/Navbar'; +import Footer from '@/components/Footer'; +import DocsLayout from '@/components/docs/DocsLayout'; + +export const metadata = { + title: 'Install WireGuard VPN — DashCaddy Docs', + description: 'Install and configure WireGuard VPN via DashCaddy. Fast, modern, secure VPN tunnel', +}; + +export default function wireguardDocsPage() { + return ( +
+ + +
+ Category: Networking + Difficulty: Advanced + Docker image: linuxserver/wireguard:latest +
+ +

What is WireGuard VPN?

+

Fast, modern, secure VPN tunnel

+

WireGuard VPN ships as a self-contained Docker image that DashCaddy provisions with one click. The platform handles the container lifecycle, DNS, reverse proxy, HTTPS certificate, and persistent storage so you can focus on using WireGuard VPN, not installing it.

+ +

Prerequisites

+
    +
  • A running DashCaddy host with the dashboard accessible.
    • +
  • No special host paths required.
    • + +
  • If you want a stable subdomain: Technitium DNS recommended (otherwise DashCaddy will use direct IP access).
    • +
+ +

Install via the DashCaddy dashboard

+
    +
  1. Sign in at https://status.sami (or your host's dashboard URL).
    2. +
  2. Open Apps → Catalog and select WireGuard VPN from the Networking category.
    3. +
  3. Choose your host (or pick Local if you have one host).
    4. +
  4. Fill in any required fields (notably the media library path and any claim token).
    5. +
  5. Click Deploy. DashCaddy will: +
      +
    1. Pull the linuxserver/wireguard:latest image.
      2. +
    2. Create persistent volumes for config and data.
      3. +
    3. Reserve a host port and wire it through Caddy.
      4. +
    4. Issue a Let's Encrypt certificate for vpn.<your-domain>.
      5. +
    5. Wait for the container health check (/) to pass.
      6. +
    +
    6. +
  6. After ~30–60 seconds the dashboard will turn the row Running and the URL will become clickable.
    7. +
+ +

Install via the REST API

+

If you script deployments or use the MCP / AI Intent Router, install with:

+ 
curl -X POST https://your-dashcaddy-host/api/v1/apps/deploy \\
+  -H "Authorization: Bearer $DASHCADDY_API_TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "template": "wireguard",
+    "host": "local",
+    "subdomain": "vpn",
+    "port": "{{PORT}}",
+    "environment": {
+      "PUID": "",
+      "PGID": "",
+      "TZ": "",
+      "SERVERURL": "",
+      "SERVERPORT": "",
+      "PEERS": ""
+    },
+    "labels": { "managed-by": "dashcaddy" }
+  }'
+

Response returns a deployment ID. Poll GET /api/v1/apps/{id}/status until state === "running".

+ +

Install via the AI Intent Router

+

From any chat surface wired to DashCaddy's MCP server, just say:

+
+

"Deploy WireGuard VPN on my home host and expose it at vpn.sami"

+
+

The Intent Router will pick the right template, prompt you for any missing fields, and start the deployment.

+ +

Post-install: first-run checklist

+
    +
  1. Configure your external IP/domain
    2. +
  2. Set up port forwarding on router
    3. +
  3. Download client configs from /config/peer1/
    4. +
+ + + +

Volumes and persistent data

+

DashCaddy creates these volume mounts:

+
    +
  • /opt/wireguard/config:/config
    • +
+

All paths are absolute host paths; the left side is the container-side mount. Restarting the container never deletes the data; reinstalling the template preserves it unless you explicitly check Wipe data on the deploy form.

+ +

Environment variables

+
  • PUID
    • +
  • PGID
    • +
  • TZ
    • +
  • SERVERURL
    • +
  • SERVERPORT
    • +
  • PEERS
+

Override any of these from the deploy form's Environment panel, or programmatically in the API environment object.

+ +

Updating

+

DashCaddy's built-in Watchtower integration will pull linuxserver/wireguard:latest every 24 hours and restart your container with zero downtime if the image digest changes. To force an update immediately, click Apps → WireGuard VPN → Update.

+ +

Backups

+

The config volume for WireGuard VPN is included in DashCaddy's default nightly snapshot. To restore on a fresh host, redeploy the same template and DashCaddy will prompt to restore from the most recent snapshot during install.

+ +

Troubleshooting

+

Common issues with WireGuard VPN:

+
    +
  • Container won't start: check the dashboard's Logs tab. Most startup failures are permission errors on the media/config volume.
    • + + +
  • Slow first scan: expected for large libraries on first run. Subsequent restarts are fast.
    • +
+

For layer-by-layer diagnostics, see the Troubleshooting guide.

+ +

Related services

+

WireGuard VPN is in the Networking category. Common pairings:

+ + +
+

+ Last reviewed against DashCaddy product version in dashcaddy-api/src/docker/app-templates.js. + Template ID: wireguard. If anything here looks wrong, edit the file and the change will appear in the next docs rebuild. +

+ + +
+ ); +} diff --git a/src/components/docs/DocsLayout.tsx b/src/components/docs/DocsLayout.tsx index 7f04b36..29f7b9a 100644 --- a/src/components/docs/DocsLayout.tsx +++ b/src/components/docs/DocsLayout.tsx @@ -8,6 +8,7 @@ const docsLinks = [ { href: '/docs/premium', label: 'Premium Features' }, { href: '/docs/api', label: 'API and Automation' }, { href: '/docs/troubleshooting', label: 'Troubleshooting' }, + { href: '/docs/catalog', label: 'App Catalog (77 apps)' }, ]; export default function DocsLayout({