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

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. Share drawings via link for real-time collaboration
  3. Export as PNG, SVG, or Excalidraw file

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.

); }