Add getting started tutorials for DashCaddy

Tutorials covering:
- Getting Started (setup wizard, timezone, deployment modes)
- Theme Customization (theme builder, presets, color customization)
- Viewing Logs (log viewer, live streaming, filtering)
- Quick Search (keyboard shortcuts, navigation)
- Backup & Restore (manual/automated backup, restore workflow)
- Stats Monitoring (resource monitor, live stats, alerts)

Also includes:
- Self-contained HTML getting started guide
- 30+ screenshots capturing UI workflows
- Issues/notes documenting test instance observations

Workflows documented:
- Light theme screenshots
- Dark theme screenshots (partial - theme builder)
- App selector (noted as empty in test instance)
- Theme builder modal
- Logs viewer
- Quick search
- Backup modal
- Stats monitoring

Total: 6 tutorial files, 30+ screenshots, 1 HTML guide
This commit is contained in:
Krystie
2026-05-01 20:53:01 -07:00
parent bb69b96816
commit fbe1a7c95c
40 changed files with 1232 additions and 0 deletions

View File

@@ -0,0 +1,113 @@
# Monitoring Resources with Stats
DashCaddy's Stats feature provides real-time and historical monitoring of CPU, memory, network, and disk usage for your containers. This tutorial shows how to access and interpret the monitoring data.
**Prerequisites:** Logged into DashCaddy dashboard with Docker containers running.
---
## Step 1: Access the Stats Modal
The Stats monitoring is found in the STATUS section of the dashboard.
**What you should see:**
- Dashboard with STATUS, TOOLS, ADMIN navigation
- Various service cards and status indicators
Navigate to the STATUS section and click on **Stats** to open the Resource Monitor.
Screenshot: `screenshots/07-stats-monitoring/light/01-dashboard.png`
---
## Step 2: The Stats Modal
The Stats modal opens with resource monitoring data organized into tabs.
**What you should see:**
- **Title:** 📊 Resource Monitor
- **Description:** "Real-time and historical CPU, memory, network, and disk usage for containers."
- **Tabs:** Live Stats, 24h Summary, Alerts
Screenshot: `screenshots/07-stats-monitoring/light/02-stats-modal-open.png`
---
## Step 3: Live Stats View
The **Live Stats** tab shows real-time resource usage.
**What you might see:**
- Container list with real-time metrics
- CPU usage percentage per container
- Memory usage (used/available)
- Network I/O rates
- Disk I/O rates
- Auto-refresh indicator: "Auto-refresh every 5s"
**Refresh controls:**
- **🔄 Refresh Now** — Manually trigger a refresh of all stats
- Automatic refresh can be paused if needed
Screenshot: `screenshots/07-stats-monitoring/light/02-stats-modal-open.png`
---
## Step 4: 24h Summary View
The **24h Summary** tab shows aggregated statistics over the past 24 hours.
**What you might see:**
- Peak CPU usage
- Average memory usage
- Total network traffic
- Disk usage trends
- Historical graphs if available
This view helps identify resource usage patterns and plan for capacity needs.
---
## Step 5: Alerts View
The **Alerts** tab shows any resource-related alerts.
**What you might see:**
- High CPU warnings
- Memory pressure alerts
- Disk space warnings
- Network issues
Alerts help you stay on top of problems before they cause service disruptions.
---
## Understanding the Metrics
**CPU Usage:**
- Shows percentage of CPU being used by each container
- High CPU (>80%) sustained may indicate performance issues
**Memory Usage:**
- Shows RAM used vs. available
- Watch for containers with memory limits approaching capacity
**Network I/O:**
- Bytes/packets in and out
- Helps identify unexpected network activity
**Disk I/O:**
- Read/write speeds
- Important for storage-heavy workloads
---
## Common Issues
| Issue | Solution |
|-------|----------|
| Stats show "Loading container stats..." | No containers running, or Docker is not responding |
| Auto-refresh not working | Click "🔄 Refresh Now" manually; check Docker daemon |
| Missing container in stats | Container may have stopped; check container status |
| Network stats show zeros | Network monitoring may not be enabled for that container |
| High CPU alerts | Check which container is using resources; consider resource limits |