fbe1a7c95c
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
176 lines
4.7 KiB
Markdown
176 lines
4.7 KiB
Markdown
# DashCaddy Getting Started Guide
|
|
|
|
A practical guide to getting started with DashCaddy — the self-hosted app dashboard.
|
|
|
|
## Table of Contents
|
|
|
|
1. [Getting Started](#getting-started) — First-time setup and configuration
|
|
2. [Theme Customization](#theme-customization) — Customize the dashboard appearance
|
|
3. [Viewing Logs](#viewing-logs) — Monitor service logs in real-time
|
|
4. [Quick Search](#quick-search) — Fast access to services and settings
|
|
5. [Backup & Restore](#backup--restore) — Protect your configuration
|
|
6. [Monitoring Resources](#monitoring-resources) — Track CPU, memory, and disk usage
|
|
|
|
---
|
|
|
|
## Getting Started
|
|
|
|
Learn how to log in, configure your timezone, and choose a deployment mode.
|
|
|
|
[Read full tutorial](tutorials/01-getting-started.md)
|
|
|
|
**What you'll learn:**
|
|
- How to log in with TOTP authentication
|
|
- How to select your timezone
|
|
- How to choose a deployment mode (Simple, Home Lab, Public, Custom)
|
|
- How to complete or skip the initial setup wizard
|
|
|
|
---
|
|
|
|
## Theme Customization
|
|
|
|
Make DashCaddy your own with custom themes and colors.
|
|
|
|
[Read full tutorial](tutorials/02-theme-customization.md)
|
|
|
|
**What you'll learn:**
|
|
- How to open the Theme Builder
|
|
- How to use preset themes (Dark, Light, Nord, Dracula, etc.)
|
|
- How to customize colors for backgrounds, text, accents, and status indicators
|
|
- How to save, import, and export themes
|
|
|
|
---
|
|
|
|
## Viewing Logs
|
|
|
|
Monitor your services with real-time log streaming.
|
|
|
|
[Read full tutorial](tutorials/03-viewing-logs.md)
|
|
|
|
**What you'll learn:**
|
|
- How to access the logs viewer
|
|
- How to navigate and filter log entries
|
|
- How to use live log streaming
|
|
- How to control the number of displayed log lines
|
|
|
|
---
|
|
|
|
## Quick Search
|
|
|
|
Find services and settings instantly.
|
|
|
|
[Read full tutorial](tutorials/04-quick-search.md)
|
|
|
|
**What you'll learn:**
|
|
- How to open Quick Search (Ctrl+K / Cmd+K)
|
|
- How to search for services and settings
|
|
- How to navigate and select results with keyboard shortcuts
|
|
- Keyboard shortcuts: ESC, ↑↓ Navigate, Enter Select
|
|
|
|
---
|
|
|
|
## Backup & Restore
|
|
|
|
Protect your configuration with full backups.
|
|
|
|
[Read full tutorial](tutorials/05-backup-restore.md)
|
|
|
|
**What you'll learn:**
|
|
- How to create a manual backup
|
|
- What's included in a full backup (services, credentials, themes)
|
|
- How to restore from a backup file
|
|
- How to set up automated backups
|
|
- How to view backup history
|
|
|
|
---
|
|
|
|
## Monitoring Resources
|
|
|
|
Track CPU, memory, network, and disk usage in real-time.
|
|
|
|
[Read full tutorial](tutorials/06-stats-monitoring.md)
|
|
|
|
**What you'll learn:**
|
|
- How to access the Resource Monitor
|
|
- How to interpret live stats and historical summaries
|
|
- How to set up alerts for resource thresholds
|
|
- Understanding CPU, memory, network, and disk metrics
|
|
|
|
---
|
|
|
|
## Common Tasks
|
|
|
|
### Adding Your First App
|
|
|
|
> **Note:** App deployment requires the app catalog to be configured with your DashCaddy instance.
|
|
|
|
1. Navigate to **TOOLS** → **App Selector**
|
|
2. Browse available apps or use Quick Search
|
|
3. Select an app template
|
|
4. Configure the app settings (URL, subdomain, credentials)
|
|
5. Deploy and verify
|
|
|
|
### Checking Service Health
|
|
|
|
1. Navigate to **STATUS** → **Health Status**
|
|
2. View the health overview for all services
|
|
3. Check individual service status cards
|
|
4. Review any active incidents
|
|
|
|
### Updating Services
|
|
|
|
1. Navigate to **ADMIN** → **Updates**
|
|
2. View available updates
|
|
3. Review changelogs and release notes
|
|
4. Apply updates to individual services or all at once
|
|
|
|
---
|
|
|
|
## Keyboard Shortcuts
|
|
|
|
| Shortcut | Action |
|
|
|----------|--------|
|
|
| `Ctrl+K` / `Cmd+K` | Open Quick Search |
|
|
| `↑` / `↓` | Navigate in Quick Search |
|
|
| `Enter` | Select in Quick Search |
|
|
| `ESC` | Close modal / Cancel |
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
### Can't log in with TOTP
|
|
- Ensure your device clock is synchronized (TOTP is time-based)
|
|
- Try regenerating the code — they expire every 30 seconds
|
|
- Contact your administrator if the code is consistently rejected
|
|
|
|
### Dashboard shows no services
|
|
- Services need to be added via the App Selector
|
|
- Check that Docker is running on your server
|
|
- Verify network connectivity to your services
|
|
|
|
### Logs show "Loading..."
|
|
- The service may not have generated any logs yet
|
|
- Check that the service is actually running
|
|
- Verify the logging system is configured correctly
|
|
|
|
### Theme changes not saving
|
|
- Click "Save Theme" before closing the Theme Builder
|
|
- Check browser console for JavaScript errors
|
|
- Try a different browser if issues persist
|
|
|
|
---
|
|
|
|
## Next Steps
|
|
|
|
- [ ] Complete the initial setup wizard
|
|
- [ ] Add your first service via App Selector
|
|
- [ ] Customize the theme to your liking
|
|
- [ ] Set up automated backups
|
|
- [ ] Explore the Admin section for advanced settings
|
|
- [ ] Join the community for tips and support
|
|
|
|
---
|
|
|
|
*This guide was created for DashCaddy version as deployed on test.dashcaddy.net*
|