Files

Sami f61e85d9a7 Initial commit: DashCaddy v1.0

Full codebase including API server (32 modules + routes), dashboard frontend,
DashCA certificate distribution, installer script, and deployment skills.

2026-03-05 02:26:12 -08:00

4.5 KiB

Raw Blame History

DashCaddy Installer - Quick Start

For Developers

Setup & Run

# Install dependencies
npm install

# Run in development mode
npm start

# Build for Windows
npm run build:win

The built installer will be at: dist/win-unpacked/DashCaddy Installer.exe

For End Users

Running the Installer

Download the DashCaddy Installer executable
Run the installer (no installation required - it's portable)
Follow the 5-step wizard:

Step 1: Welcome

Review features and system requirements
Confirm detected platform

Step 2: Choose Folders

Select installation directory (default: C:\DashCaddy)
Optionally customize Docker data and Caddy config paths
Click Next

Step 3: Check Dependencies

Installer checks for Docker and Caddy
If missing, click Install buttons to install them
Wait for installation to complete
Click Install when both are ready

Step 4: Installation

Watch progress as DashCaddy is installed
Files are copied and configured automatically
Takes 1-3 minutes depending on system

Step 5: Complete

Installation successful!
Click Open Dashboard to launch DashCaddy
Dashboard opens at http://localhost:8080

What Gets Installed

The installer creates this structure:

C:\DashCaddy\
├── dashboard\          # Web dashboard files
├── api\               # API server
├── docker-data\       # Docker volumes
├── caddy\            # Caddy configuration
├── Caddyfile         # Reverse proxy config
├── docker-compose.yml # Container orchestration
└── .dashcaddy-config.json # Installation settings

System Requirements

OS: Windows 10/11, macOS 10.15+, or Linux
RAM: 4GB minimum, 8GB recommended
Disk: 2GB free space
Docker: Required (installer can install)
Caddy: Required (installer can install)

Accessing DashCaddy

After installation:

Dashboard: http://localhost:8080
API: http://localhost:3001
Caddy Admin: http://localhost:2021

Troubleshooting

Installer Won't Start

Ensure you have administrator/sudo privileges
Check antivirus isn't blocking the installer
Try running as administrator (Windows)

Dependencies Won't Install

Check internet connection
Manually install Docker from docker.com
Manually install Caddy from caddyserver.com

Dashboard Won't Open

Check if Caddy is running: caddy version
Check if Docker is running: docker ps
Verify port 8080 isn't in use
Check installation logs

Services Not Starting

Ensure Docker daemon is running
Check firewall settings
Verify installation paths are correct

Uninstalling

To remove DashCaddy:

Stop services:

cd C:\DashCaddy
docker compose down
taskkill /IM caddy.exe /F

Delete installation directory:
```
rmdir /s C:\DashCaddy
```

Next Steps