From 7cd053ab0f1a22fc00bb23e97a25242766c91e2c Mon Sep 17 00:00:00 2001 From: Sami Date: Mon, 30 Mar 2026 01:08:48 -0700 Subject: [PATCH] fix: clean up Phase 1/2 commit issues - Remove duplicate HTTP_STATUS/NETWORK exports in constants.js - Remove unused responseHelpers import from server.js - Remove backup file and doc artifacts from tracking - Update .gitignore to prevent re-adding bloat files Co-Authored-By: Claude Opus 4.6 --- dashcaddy-api/constants.js | 4 - dashcaddy-api/server.js | 1 - dashcaddy-installer/.gitignore | 2 + dashcaddy-installer/LOGO_INTEGRATION.md | 123 - dashcaddy-installer/README-TESTER.txt | 149 - status/.gitignore | 5 + status/DEPLOYMENT_GUIDE.md | 402 - status/EMBY_DEPLOYMENT.md | 229 - status/QUICK_DEPLOY_EMBY.md | 183 - status/README.md | 214 - status/index.html.backup-before-file-logs | 8125 --------------------- 11 files changed, 7 insertions(+), 9430 deletions(-) delete mode 100644 dashcaddy-installer/LOGO_INTEGRATION.md delete mode 100644 dashcaddy-installer/README-TESTER.txt delete mode 100644 status/DEPLOYMENT_GUIDE.md delete mode 100644 status/EMBY_DEPLOYMENT.md delete mode 100644 status/QUICK_DEPLOY_EMBY.md delete mode 100644 status/README.md delete mode 100644 status/index.html.backup-before-file-logs diff --git a/dashcaddy-api/constants.js b/dashcaddy-api/constants.js index 43056da..207c618 100644 --- a/dashcaddy-api/constants.js +++ b/dashcaddy-api/constants.js @@ -183,8 +183,4 @@ module.exports = { buildMediaAuth, HTTP_STATUS, NETWORK, - HTTP_STATUS, - NETWORK, }; - - diff --git a/dashcaddy-api/server.js b/dashcaddy-api/server.js index 8b090f5..ea26212 100644 --- a/dashcaddy-api/server.js +++ b/dashcaddy-api/server.js @@ -60,7 +60,6 @@ const auditLogger = require('./audit-logger'); const portLockManager = require('./port-lock-manager'); const dockerSecurity = require('./docker-security'); const authManager = require('./auth-manager'); -const responseHelpers = require('./response-helpers'); const configureMiddleware = require('./middleware'); const { validateStartupConfig, syncHealthCheckerServices } = require('./startup-validator'); const { CSRF_HEADER_NAME } = require('./csrf-protection'); diff --git a/dashcaddy-installer/.gitignore b/dashcaddy-installer/.gitignore index ec523d1..4f2bd88 100644 --- a/dashcaddy-installer/.gitignore +++ b/dashcaddy-installer/.gitignore @@ -3,3 +3,5 @@ dist/ *.log .DS_Store Thumbs.db +LOGO_INTEGRATION.md +README-TESTER.txt diff --git a/dashcaddy-installer/LOGO_INTEGRATION.md b/dashcaddy-installer/LOGO_INTEGRATION.md deleted file mode 100644 index 5e86206..0000000 --- a/dashcaddy-installer/LOGO_INTEGRATION.md +++ /dev/null @@ -1,123 +0,0 @@ -# DashCaddy Logo Integration - Complete ✅ - -## Summary - -Your DashCaddy logo has been successfully integrated into the installer in multiple places. - -## What Was Updated - -### 1. Welcome Screen Logo ✅ -**Location**: `src/renderer/wizard.js` - -**Before**: Placeholder "DC" text in a gradient box -**After**: Your actual DashCaddy logo image - -```javascript -// Now displays your logo -DashCaddy Logo -``` - -The logo displays on the welcome screen when users first open the installer. - -### 2. Application Icon ✅ -**Location**: `package.json` build configuration - -**Icon Used**: `assets/app-icon.png` (copy of "dashcaddy logo icon.png") - -This icon appears: -- In the Windows taskbar when installer is running -- In the title bar of the installer window -- In Windows Explorer for the .exe file -- In the Windows Start menu (if pinned) - -### 3. CSS Styling ✅ -**Location**: `src/renderer/styles.css` - -Updated logo container styles to: -- Center the logo properly -- Set max dimensions (200px width, 120px height) -- Use `object-fit: contain` for proper scaling -- Maintain aspect ratio - -## Logo Assets Available - -Your installer includes these logo files in `assets/`: - -``` -assets/ -├── dashcaddy logo blue.png (67.58 KB) -├── DashCaddy logo dark.png (1049.79 KB) - High res -├── dashcaddy logo icon.png (27.28 KB) - Icon version -├── dashcaddy logo light.png (16.63 KB) -├── dashcaddy logo.png (103.98 KB) -├── dashcaddy-logo.png (103.98 KB) - Used in welcome screen -├── app-icon.png (27.28 KB) - Used as app icon -└── icon.ico (15.09 KB) - Windows favicon -``` - -## Where Your Logo Appears - -### During Installation -1. **Welcome Screen** - Large logo at top of welcome page -2. **Window Icon** - Small icon in title bar and taskbar -3. **Installer Executable** - Icon shown in Windows Explorer - -### After Build -- The built executable (`DashCaddy Installer.exe`) displays your icon -- Users see your branding throughout the installation process - -## Technical Details - -### Logo Display Settings -- **Max Width**: 200px -- **Max Height**: 120px -- **Scaling**: Maintains aspect ratio -- **Alignment**: Centered -- **Format**: PNG with transparency support - -### Icon Requirements -- **Format**: PNG (electron-builder converts to .ico automatically) -- **Minimum Size**: 256x256 pixels recommended -- **Used Icon**: `app-icon.png` (27.28 KB) - -## Build Status - -✅ **Build Successful** with logo integration -- Installer rebuilt with proper branding -- Logo displays correctly in UI -- App icon shows in Windows - -**Build Output**: `dist/win-unpacked/DashCaddy Installer.exe` (168.62 MB) - -## Testing Checklist - -To verify logo integration: - -1. ✅ Run installer: `npm start` -2. ✅ Check welcome screen shows DashCaddy logo (not "DC" placeholder) -3. ✅ Check window title bar shows icon -4. ✅ Check taskbar shows icon when running -5. ✅ Check .exe file in Explorer shows icon -6. ✅ Build completes without icon errors - -## Future Enhancements - -Consider adding: -- [ ] Animated logo on loading screen -- [ ] Logo in success/complete screen -- [ ] Branded splash screen while Electron loads -- [ ] Custom window frame with logo -- [ ] Logo in About dialog - -## Files Modified - -1. `src/renderer/wizard.js` - Added logo image to welcome screen -2. `src/renderer/styles.css` - Updated logo container styles -3. `package.json` - Updated icon configuration -4. `assets/app-icon.png` - Added (copy of dashcaddy logo icon.png) - -## Result - -Your DashCaddy branding is now fully integrated into the installer. Users will see your professional logo throughout the installation experience, reinforcing your brand identity. - -**Status**: Complete and tested ✅ diff --git a/dashcaddy-installer/README-TESTER.txt b/dashcaddy-installer/README-TESTER.txt deleted file mode 100644 index dae5470..0000000 --- a/dashcaddy-installer/README-TESTER.txt +++ /dev/null @@ -1,149 +0,0 @@ -DashCaddy v1.0 -================================== -Copyright (c) 2026 Sami Ahmed. All rights reserved. - -This software is provided to you, Nick G, for testing and evaluation -purposes only. This is pre-release software (beta). You may not -redistribute, modify, or share this software or any of its components -without written permission from the author. By using this software you -acknowledge that Sami Ahmed is the sole author and copyright holder. - -Your feedback, bug reports, and pen-testing findings are welcome and -appreciated — that's the whole point of this test build. - - -WHAT IS DASHCADDY? ------------------- -DashCaddy is a home lab management platform. It gives you a single -dashboard to manage Docker containers, a Caddy reverse proxy, and DNS — -all from a web browser. Think of it as a control panel for self-hosted -services on your home network. - -With DashCaddy you can: - - Deploy apps (Plex, Jellyfin, Sonarr, Radarr, etc.) with one click - - Manage your reverse proxy (Caddy) so each app gets its own domain - - Access everything through a clean web dashboard - - Use HTTPS on your local network with an internal Certificate Authority - - -WHAT YOU NEED -------------- - - Windows 10 or 11 (64-bit) - - 4 GB RAM minimum - - 2 GB free disk space - - Internet connection (for downloading Docker and Caddy during setup) - - Hardware virtualization enabled in BIOS (required for Docker/WSL2) - - -HOW TO INSTALL --------------- -1. Double-click "DashCaddy Installer 1.0.0.exe" - - Windows SmartScreen may warn you since this isn't signed software. - Click "More info" then "Run anyway" to proceed. - -2. WELCOME SCREEN - The installer will detect your OS and show you what's included. - Click "Next" to continue. - -3. DEPENDENCIES - The installer checks if Docker and Caddy are installed on your PC. - - If Docker is missing, it will download and install Docker Desktop - for you. This may require a restart to set up WSL2. - - If Caddy is missing, it will download and install the Caddy binary. - Click "Next" once both show green checkmarks. - -4. INSTALL PATH - Choose where DashCaddy will live on your machine. - Default is C:\DashCaddy — that's fine for most people. - -5. TIER SELECTION - Pick what you want to set up: - - Basic: Dashboard only (static page, no Docker) - - Standard (recommended): Dashboard + API server in Docker - - Full Stack: Everything above + DNS management via Technitium - For testing, "Standard" is the best starting point. - -6. ACCESS MODE - How do you want to reach the dashboard? - - Local Only: Access via http://localhost:8080 (simplest) - - Public Domain: Use a real domain with Let's Encrypt HTTPS - - Custom TLD: Use made-up domains like dashcaddy.home, plex.home - (requires a DNS server to resolve those names) - For testing, "Local Only" is the easiest. You can change this later. - -7. DASHBOARD SETUP - Customize the name, colors, and logo. Defaults are fine to start. - -8. INSTALLATION - Watch the progress bar as the installer: - - Copies dashboard and API files - - Generates your Caddyfile (reverse proxy config) - - Generates docker-compose.yml - - Creates encryption keys for credential storage - - Starts Caddy and the Docker container - - Runs health checks - -9. COMPLETE - You'll see a success screen with your dashboard URL. Click "Open - Dashboard" to launch it in your browser. - - -USING THE DASHBOARD -------------------- -Once installed, the dashboard is your home base: - - - APP SELECTOR: Browse 50+ app templates (media servers, download - managers, chat platforms, etc.). Click "Deploy" on any app and - DashCaddy creates the Docker container, sets up the reverse proxy, - and adds it to your dashboard automatically. - - - SERVICE CARDS: Each deployed app shows as a card on the dashboard - with status (online/offline), quick links, and controls. - - - CADDY MANAGEMENT: View and reload your reverse proxy configuration - without touching config files. - - - DNS MANAGEMENT (Full Stack tier): Manage DNS records so your custom - domains resolve to the right services. - - -WHAT TO TEST / PENTEST ----------------------- -Things I'd especially like feedback on: - - 1. Does the installer run cleanly on your machine? - 2. Do Docker and Caddy get installed without issues? - 3. Can you deploy an app from the app selector? - 4. Try breaking things — bad inputs, weird characters in names, - rapid clicking, deploying multiple apps at once. - 5. Security: the API runs on port 3001. See if you can find any - vulnerabilities (injection, auth bypass, path traversal, etc.). - 6. Try the different access modes if you're feeling adventurous. - -Report anything you find back to me — crashes, confusing steps, security -issues, or just things that felt weird. Screenshots are always helpful. - - -UNINSTALLING ------------- -To remove DashCaddy: - 1. Stop Docker containers: docker compose down - (from the dashcaddy-api folder inside your install path) - 2. Stop Caddy (kill the process or close the terminal) - 3. Delete the installation folder (e.g. C:\DashCaddy) - 4. Optionally uninstall Docker Desktop from Windows Settings - - -KNOWN LIMITATIONS (beta) ------------------------- - - The installer exe is not code-signed, so Windows SmartScreen will - flag it. This is normal for pre-release software. - - Docker Desktop's WSL2 setup may require a Windows restart. - - Custom TLD mode requires a DNS server. You can deploy Technitium - DNS directly from the app selector and plug it into the dashboard. - - Some app templates may need manual configuration after deployment. - - -Thanks for testing, Nick. Your feedback helps make this better. - -- Sami diff --git a/status/.gitignore b/status/.gitignore index b947077..8d4a116 100644 --- a/status/.gitignore +++ b/status/.gitignore @@ -1,2 +1,7 @@ node_modules/ dist/ +*.backup-* +DEPLOYMENT_GUIDE.md +EMBY_DEPLOYMENT.md +QUICK_DEPLOY_EMBY.md +README.md diff --git a/status/DEPLOYMENT_GUIDE.md b/status/DEPLOYMENT_GUIDE.md deleted file mode 100644 index 63c9f81..0000000 --- a/status/DEPLOYMENT_GUIDE.md +++ /dev/null @@ -1,402 +0,0 @@ -# SAMI-CLOUD Status Dashboard - Deployment Guide - -Complete guide for deploying and using the SAMI-CLOUD Status Dashboard with app deployment capabilities. - -## Overview - -The SAMI-CLOUD Status Dashboard is a web application that: -- Monitors service status in real-time -- Provides weather information -- Allows deploying new apps via a user-friendly interface -- Automatically creates DNS records and Caddy reverse proxy configurations -- Works cross-platform (Windows, Linux, macOS) - -## Architecture - -``` -┌─────────────────────────────────────────────────────────┐ -│ User Browser │ -│ (https://status.sami) │ -└────────────────────┬────────────────────────────────────┘ - │ - ▼ -┌─────────────────────────────────────────────────────────┐ -│ Caddy Server │ -│ - Serves static files (index.html, assets) │ -│ - Proxies /api/* to Node.js API server │ -│ - Provides TLS with internal CA │ -└────────────────────┬────────────────────────────────────┘ - │ - ▼ -┌─────────────────────────────────────────────────────────┐ -│ Node.js API Server (port 3001) │ -│ - Handles app deployment requests │ -│ - Creates DNS records via Technitium API │ -│ - Configures Caddy routes via Admin API │ -└───────┬─────────────────────────────┬───────────────────┘ - │ │ - ▼ ▼ -┌──────────────────┐ ┌──────────────────┐ -│ Caddy Admin API │ │ Technitium DNS │ -│ (port 2019) │ │ API (port 5380) │ -└──────────────────┘ └──────────────────┘ -``` - -## Prerequisites - -1. **Caddy Server** with Admin API enabled -2. **Node.js** v14 or higher -3. **Technitium DNS Server** (optional, for DNS management) -4. **npm** (comes with Node.js) - -## Step 1: Configure Caddy - -### 1.1 Enable Caddy Admin API - -Add to your Caddyfile (global options): - -```caddyfile -{ - admin localhost:2019 { - origins localhost localhost:2019 - } -} -``` - -### 1.2 Configure Status Dashboard Site - -Add this block to your Caddyfile: - -```caddyfile -status.sami { - tls internal - - # API proxy to Node.js server - handle /api/* { - reverse_proxy localhost:3001 - } - - # Probe endpoints for service status checks - handle_path /probe/* { - header Content-Type application/json - respond `{"ok":true}` 200 - } - - # Static site - root * C:/caddy/sites/status - file_server -} -``` - -### 1.3 Reload Caddy - -```bash -caddy reload --config /path/to/Caddyfile -``` - -## Step 2: Deploy Dashboard Files - -### 2.1 Copy Files to Production - -Copy the status dashboard files to your Caddy web root: - -```bash -# On Windows -xcopy /E /I e:\CaddyCerts\sites\status C:\caddy\sites\status - -# On Linux/macOS -cp -r /path/to/development/sites/status /var/www/status -``` - -### 2.2 Verify File Structure - -``` -C:/caddy/sites/status/ -├── index.html -├── apps.json -├── sw.js -├── assets/ -│ ├── fonts/ -│ ├── weather/ -│ ├── *.png (app logos) -│ └── ... -└── api/ - ├── caddy-api.js - ├── package.json - ├── README.md - └── node_modules/ -``` - -## Step 3: Set Up API Server - -### 3.1 Install Dependencies - -```bash -cd C:/caddy/sites/status/api # or your path -npm install -``` - -### 3.2 Configure Environment Variables - -#### Windows (PowerShell - Persistent) -```powershell -# Set system environment variables -[System.Environment]::SetEnvironmentVariable('CADDY_ADMIN_API', 'http://localhost:2019', 'User') -[System.Environment]::SetEnvironmentVariable('DNS_SERVER_API', 'http://192.168.254.204:5380', 'User') -[System.Environment]::SetEnvironmentVariable('TECHNITIUM_API_TOKEN', 'your_token_here', 'User') -``` - -#### Linux/macOS (Persistent) -Add to `~/.bashrc` or `~/.zshrc`: - -```bash -export CADDY_ADMIN_API=http://localhost:2019 -export DNS_SERVER_API=http://192.168.254.204:5380 -export TECHNITIUM_API_TOKEN=your_token_here -``` - -Then reload: -```bash -source ~/.bashrc # or source ~/.zshrc -``` - -### 3.3 Get Technitium API Token - -1. Open Technitium DNS web interface (e.g., `http://dns1.sami:5380`) -2. Log in with admin credentials -3. Go to **Settings → API** -4. Generate a new token or copy existing one -5. Set as `TECHNITIUM_API_TOKEN` environment variable - -### 3.4 Test the API Server - -```bash -node test-api.js -``` - -Expected output: -``` -Testing SAMI-CLOUD API... - -1. Testing health endpoint... - ✓ Health check passed - -2. Testing API test endpoint... - ✓ API test passed - Platform: win32 - Caddy Admin API: http://localhost:2019 - DNS Server API: http://192.168.254.204:5380 - DNS Token: Configured - -3. Testing services endpoint... - ✓ Services endpoint passed - Found 8 services - -Tests complete! -``` - -## Step 4: Run the API Server - -### Option A: Run Directly (for testing) - -```bash -node caddy-api.js -``` - -### Option B: Use PM2 (recommended for production) - -```bash -# Install PM2 globally -npm install -g pm2 - -# Start the API server -pm2 start caddy-api.js --name sami-api - -# Save the process list -pm2 save - -# Set up PM2 to start on boot -pm2 startup -``` - -Manage with PM2: -```bash -pm2 status # Check status -pm2 logs sami-api # View logs -pm2 restart sami-api -pm2 stop sami-api -``` - -### Option C: Windows Service (using PM2) - -```bash -npm install -g pm2-windows-service -pm2-service-install -n SAMI-API -``` - -### Option D: systemd (Linux) - -Create `/etc/systemd/system/sami-api.service`: - -```ini -[Unit] -Description=SAMI-CLOUD API Server -After=network.target - -[Service] -Type=simple -User=caddy -WorkingDirectory=/var/www/status/api -Environment="NODE_ENV=production" -Environment="CADDY_ADMIN_API=http://localhost:2019" -Environment="DNS_SERVER_API=http://192.168.254.204:5380" -Environment="TECHNITIUM_API_TOKEN=your_token" -ExecStart=/usr/bin/node caddy-api.js -Restart=on-failure -RestartSec=10 - -[Install] -WantedBy=multi-user.target -``` - -Enable and start: -```bash -sudo systemctl daemon-reload -sudo systemctl enable sami-api -sudo systemctl start sami-api -sudo systemctl status sami-api -``` - -## Step 5: Verify Everything Works - -### 5.1 Access the Dashboard - -Open your browser and navigate to: -``` -https://status.sami -``` - -You should see: -- Service status cards -- Weather widget -- Theme toggle -- "📱 App Selector" button - -### 5.2 Test App Deployment - -1. Click **"📱 App Selector"** button -2. Choose an app template (or use the generic one) -3. Fill in the deployment form: - - **Subdomain**: e.g., `test-app` - - **IP Address**: e.g., `192.168.1.100` - - **Port**: e.g., `8080` - - **DNS Type**: Choose "Private DNS" or "Public DNS" - - **SSL Type**: Choose "Internal CA" or "Public (Let's Encrypt)" -4. Click **"Deploy App"** - -If successful, you should see: -- Success message -- New card appears in the grid -- App is accessible at `https://test-app.sami` - -## Troubleshooting - -### Dashboard not accessible -- Check Caddy is running: `caddy version` -- Check Caddyfile syntax: `caddy validate --config /path/to/Caddyfile` -- View Caddy logs for errors - -### API requests failing -- Verify API server is running: `pm2 status` or check process -- Check API logs: `pm2 logs sami-api` -- Test API directly: `curl http://localhost:3001/health` - -### DNS records not created -- Verify `TECHNITIUM_API_TOKEN` is set correctly -- Test DNS API manually: - ```bash - curl "http://192.168.254.204:5380/api/zones/records/get?token=YOUR_TOKEN&domain=sami" - ``` -- Check Technitium DNS server is running - -### Caddy routes not working -- Verify Caddy Admin API is accessible: - ```bash - curl http://localhost:2019/config/ - ``` -- Check Caddy admin API origins in Caddyfile -- View Caddy configuration: `curl http://localhost:2019/config/ | jq .` - -### App deployment fails -1. Check API server logs -2. Verify all environment variables are set -3. Test each component individually: - - DNS API connection - - Caddy Admin API connection -4. Check for existing configurations with same subdomain - -## Advanced Configuration - -### Custom App Templates - -Edit the dashboard's JavaScript to add custom app templates with pre-configured settings. - -### Multiple DNS Servers - -Modify the API to support multiple DNS servers for redundancy. - -### Docker Integration - -Extend the API to deploy Docker containers automatically before configuring DNS and Caddy. - -### Authentication - -Add authentication middleware to the API server to protect deployment endpoints. - -## Maintenance - -### Backup Important Files - -Regularly backup: -- `C:/caddy/Caddyfile` (or equivalent) -- `C:/caddy/sites/status/apps.json` -- Custom app data in localStorage (export from browser) - -### Update the Dashboard - -1. Pull latest changes from development -2. Copy updated files to production -3. Restart API server if needed -4. Clear browser cache or bump cache version in `sw.js` - -### Monitor Logs - -```bash -# API logs -pm2 logs sami-api - -# Caddy logs -caddy logs - -# System logs (Linux) -journalctl -u sami-api -f -``` - -## Security Considerations - -1. **API Access**: The API server should only be accessible from localhost or trusted networks -2. **DNS Token**: Keep your Technitium API token secure -3. **Caddy Admin API**: Restrict access to localhost only -4. **CORS**: The API has CORS enabled - restrict origins in production -5. **Input Validation**: The API validates inputs but consider additional security layers - -## Support - -For issues or questions: -- Check the API README: `api/README.md` -- Review Caddy documentation: https://caddyserver.com/docs/ -- Check Technitium DNS docs: https://technitium.com/dns/ - -## License - -MIT diff --git a/status/EMBY_DEPLOYMENT.md b/status/EMBY_DEPLOYMENT.md deleted file mode 100644 index da539e1..0000000 --- a/status/EMBY_DEPLOYMENT.md +++ /dev/null @@ -1,229 +0,0 @@ -# Deploying Emby Server with SAMI-CLOUD Dashboard - -Quick guide to deploy Emby media server using the SAMI-CLOUD Status Dashboard. - -## Prerequisites - -1. Emby Server installed somewhere (Docker, Windows, Linux, etc.) -2. SAMI-CLOUD API server running (`node caddy-api.js`) -3. Know the IP and port where Emby is running - -## Option 1: Deploy Existing Emby Server - -If you already have Emby running somewhere, use the dashboard to add it: - -### Step 1: Gather Information - -You'll need: -- **IP Address**: Where Emby is running (e.g., `192.168.254.100`) -- **Port**: Emby's HTTP port (default: `8096`) - -### Step 2: Deploy via Dashboard - -1. Open the dashboard: `https://status.sami` -2. Click **"📱 App Selector"** button -3. Find **Emby** under the **Media** category -4. Fill in the deployment form: - ``` - Subdomain: emby - IP Address: 192.168.254.100 - Port: 8096 - DNS Type: Private DNS (creates DNS record) - SSL Type: Internal CA (local network) - ``` -5. Click **"Deploy App"** - -### Step 3: Access Emby - -Your Emby server will be accessible at: -``` -https://emby.sami -``` - -## Option 2: Deploy Emby in Docker - -If you don't have Emby yet, here's how to deploy it with Docker: - -### Using Docker Compose - -Create `docker-compose.yml`: - -```yaml -version: '3' -services: - emby: - image: lscr.io/linuxserver/emby:latest - container_name: emby - environment: - - PUID=1000 - - PGID=1000 - - TZ=America/New_York - volumes: - - ./config:/config - - /path/to/media:/data/media - - /path/to/movies:/data/movies - - /path/to/tvshows:/data/tvshows - ports: - - "8096:8096" - restart: unless-stopped -``` - -Then: -```bash -docker-compose up -d -``` - -### Using Docker CLI - -```bash -docker run -d \ - --name=emby \ - -e PUID=1000 \ - -e PGID=1000 \ - -e TZ=America/New_York \ - -p 8096:8096 \ - -v /path/to/config:/config \ - -v /path/to/media:/data/media \ - --restart unless-stopped \ - lscr.io/linuxserver/emby:latest -``` - -### After Docker Deployment - -1. Verify Emby is running: `docker ps` -2. Test access: `curl http://localhost:8096` -3. Use the Dashboard App Selector to add reverse proxy: - - IP: `localhost` or `172.17.0.1` (Docker bridge) - - Port: `8096` - -## Option 3: Install Emby Directly - -### Windows - -1. Download Emby Server: https://emby.media/download.html -2. Install and run setup wizard -3. Note the IP and port (default: `8096`) -4. Use Dashboard App Selector to add it - -### Linux - -```bash -# Ubuntu/Debian -wget https://github.com/MediaBrowser/Emby.Releases/releases/download/4.8.0.62/emby-server-deb_4.8.0.62_amd64.deb -sudo dpkg -i emby-server-deb_4.8.0.62_amd64.deb - -# Start service -sudo systemctl start emby-server -sudo systemctl enable emby-server -``` - -Then add to dashboard with IP and port `8096`. - -## Emby Initial Setup - -After deploying, complete Emby's setup wizard: - -1. Open `https://emby.sami` -2. Choose your language -3. Create admin account -4. Add media libraries (Movies, TV Shows, Music, etc.) -5. Configure metadata providers -6. Set up remote access (if needed) - -## Troubleshooting - -### Can't access Emby through reverse proxy - -Check that Emby allows the proxy: - -1. Open Emby Settings → Network -2. Add to **"Allow remote connections from"**: - - Your Caddy server IP - - `127.0.0.1` -3. Ensure **"Enable automatic port mapping"** is off (not needed with reverse proxy) - -### Certificate errors - -If using Internal CA: -- Ensure you've installed the Caddy root certificate on your devices -- Export from: `https://dns1.sami/config/pki/ca/local/download` - -### Performance issues - -If streaming is slow: -1. Check network bandwidth -2. Enable hardware transcoding in Emby (Settings → Transcoding) -3. Adjust quality settings in Emby clients - -### DNS not resolving - -If `emby.sami` doesn't resolve: -```bash -# Test DNS -nslookup emby.sami dns1.sami - -# Add manually if needed -# Windows: C:\Windows\System32\drivers\etc\hosts -# Linux/Mac: /etc/hosts -192.168.254.100 emby.sami -``` - -## Updating Emby Logo - -The dashboard now has the official Emby logo. If you want to customize it: - -1. Replace: `e:\CaddyCerts\sites\status\assets\emby.png` -2. Copy to production: `C:\caddy\sites\status\assets\emby.png` -3. Clear browser cache - -## Advanced: Emby with Custom Settings - -You can configure additional Caddy settings for Emby: - -```caddyfile -emby.sami { - tls internal - - # Increase timeouts for long transcoding operations - reverse_proxy http://192.168.254.100:8096 { - flush_interval -1 - - transport http { - dial_timeout 30s - response_header_timeout 0 - read_timeout 0 - } - } -} -``` - -## Next Steps - -After Emby is deployed: - -1. **Add Media Libraries** - Configure your movies, TV shows, music -2. **Install Plugins** - Trailers, Trakt, Theme Songs, etc. -3. **Setup Users** - Create accounts for family members -4. **Configure Clients** - Install Emby apps on phones, TVs, streaming devices -5. **Enable Live TV** - If you have TV tuners or IPTV - -## Comparing Emby vs Plex vs Jellyfin - -| Feature | Emby | Plex | Jellyfin | -|---------|------|------|----------| -| Free features | Most | Some | All | -| Hardware transcoding | Premiere only | Pass only | Free | -| Open source | No | No | Yes | -| Mobile apps | Paid | Free | Free | -| Best for | Power users | Everyone | Self-hosters | - -## Resources - -- Emby Documentation: https://support.emby.media/ -- Emby Forums: https://emby.media/community/ -- Docker Hub: https://hub.docker.com/r/emby/embyserver -- LinuxServer.io: https://docs.linuxserver.io/images/docker-emby/ - -## License - -Emby has both free and Premiere (paid) versions. Some features require Emby Premiere subscription. diff --git a/status/QUICK_DEPLOY_EMBY.md b/status/QUICK_DEPLOY_EMBY.md deleted file mode 100644 index 20375d1..0000000 --- a/status/QUICK_DEPLOY_EMBY.md +++ /dev/null @@ -1,183 +0,0 @@ -# Quick Emby Deployment Guide - -## TL;DR - Deploy Emby Right Now - -### If you have Emby already running: - -1. Open dashboard: `https://status.sami` -2. Click **📱 App Selector** -3. Click **Emby** (under Media category) -4. Enter your Emby server's **IP** and **Port** (default: 8096) -5. Click **Deploy** -6. Access at: `https://emby.sami` - -### If you need to install Emby first: - -**Quick Docker Deploy:** -```bash -docker run -d \ - --name=emby \ - -e PUID=1000 \ - -e PGID=1000 \ - -e TZ=America/New_York \ - -p 8096:8096 \ - -v ./emby-config:/config \ - -v /path/to/movies:/data/movies \ - -v /path/to/tvshows:/data/tvshows \ - --restart unless-stopped \ - lscr.io/linuxserver/emby:latest -``` - -**Then add to dashboard:** -1. Dashboard → 📱 App Selector → Emby -2. IP: `localhost` or your server IP -3. Port: `8096` -4. Deploy! - -## Deployment Form Values - -``` -Subdomain: emby -IP Address: [your server IP] -Port: 8096 -DNS Type: ⦿ Private DNS (recommended for local network) -SSL Type: ⦿ Internal CA (recommended for .sami domain) -``` - -## What Happens When You Deploy - -1. ✅ DNS A record created: `emby.sami → your IP` -2. ✅ Caddy reverse proxy configured -3. ✅ SSL certificate generated (internal CA) -4. ✅ Accessible at: `https://emby.sami` - -## Common Deployment Scenarios - -### Scenario 1: Emby on Windows PC -``` -IP: 192.168.254.100 (your PC's IP) -Port: 8096 -``` - -### Scenario 2: Emby in Docker on same Caddy server -``` -IP: localhost or 172.17.0.1 -Port: 8096 -``` - -### Scenario 3: Emby on another server (Tailscale IP) -``` -IP: 100.xx.xx.xx (Tailscale IP) -Port: 8096 -``` - -### Scenario 4: Emby on NAS -``` -IP: 192.168.254.50 (NAS IP) -Port: 8096 -``` - -## Verify Deployment - -```bash -# Test DNS -nslookup emby.sami dns1.sami - -# Test HTTPS (from Caddy server) -curl -k https://emby.sami - -# Check Caddy configuration -curl http://localhost:2019/config/ | jq '.apps.http.servers.srv0.routes[] | select(.["@id"] == "emby.sami")' - -# Check if Emby responds -curl http://[your-emby-ip]:8096/emby/System/Info/Public -``` - -## Quick Fixes - -**Emby not accessible after deployment:** -```bash -# Check Emby is running -curl http://[ip]:8096 - -# Check Caddy route exists -curl http://localhost:2019/id/emby.sami - -# Check DNS record -curl "http://192.168.254.204:5380/api/zones/records/get?token=$TECHNITIUM_API_TOKEN&domain=emby.sami" -``` - -**Remove and redeploy:** -1. Delete the card from dashboard (🗑️ button) -2. Deploy again through App Selector - -## Manual Caddy Configuration (Alternative) - -If you prefer manual configuration, add to Caddyfile: - -```caddyfile -emby.sami { - tls internal - reverse_proxy http://192.168.254.100:8096 -} -``` - -Then: -```bash -caddy reload --config C:\caddy\Caddyfile -``` - -## Docker-Compose Full Stack - -Deploy Emby + monitoring: - -```yaml -version: '3.8' -services: - emby: - image: lscr.io/linuxserver/emby:latest - container_name: emby - environment: - - PUID=1000 - - PGID=1000 - - TZ=America/New_York - volumes: - - ./emby:/config - - /media/movies:/data/movies - - /media/tv:/data/tv - ports: - - "8096:8096" - restart: unless-stopped -``` - -Deploy: -```bash -docker-compose up -d -``` - -Then use App Selector to add reverse proxy! - -## Next Steps After Deployment - -1. **Initial Setup**: Visit `https://emby.sami` and complete wizard -2. **Add Libraries**: Settings → Library → Add Media Library -3. **Install Clients**: Get Emby apps for your devices -4. **Configure Transcoding**: Settings → Transcoding (enable hardware if supported) -5. **Setup Users**: Settings → Users → Add User - -## Need Help? - -- Full guide: See [EMBY_DEPLOYMENT.md](EMBY_DEPLOYMENT.md) -- API docs: See [api/README.md](api/README.md) -- General setup: See [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) - -## One-Liner Docker + Dashboard Deploy - -```bash -# Start Emby -docker run -d --name=emby -p 8096:8096 -e TZ=America/New_York -v ./emby:/config lscr.io/linuxserver/emby:latest - -# Then open https://status.sami and use App Selector! -``` - -That's it! 🎬 diff --git a/status/README.md b/status/README.md deleted file mode 100644 index e21f402..0000000 --- a/status/README.md +++ /dev/null @@ -1,214 +0,0 @@ -# SAMI-CLOUD Status Dashboard - -A modern, cross-platform status dashboard with built-in app deployment capabilities. - -## Features - -- **Real-time Service Monitoring** - Monitor all your services with live status checks -- **Weather Integration** - Display current weather conditions -- **One-Click App Deployment** - Deploy new apps with automatic DNS and reverse proxy configuration -- **Cross-Platform** - Works on Windows, Linux, and macOS -- **API-Driven** - Uses Caddy Admin API and Technitium DNS API (no scripts required) -- **PWA Support** - Install as a Progressive Web App -- **Responsive Design** - Works on desktop, tablet, and mobile -- **Dark/Light Themes** - Multiple theme options - -## Quick Start - -### 1. Install Dependencies - -```bash -cd api -npm install -``` - -### 2. Set Environment Variables - -```bash -# Windows (PowerShell) -$env:CADDY_ADMIN_API="http://localhost:2019" -$env:DNS_SERVER_API="http://192.168.254.204:5380" -$env:TECHNITIUM_API_TOKEN="your_token_here" - -# Linux/macOS -export CADDY_ADMIN_API=http://localhost:2019 -export DNS_SERVER_API=http://192.168.254.204:5380 -export TECHNITIUM_API_TOKEN=your_token_here -``` - -### 3. Start the API Server - -```bash -# Windows -cd api -start.bat - -# Linux/macOS -cd api -./start.sh -``` - -### 4. Configure Caddy - -Add to your Caddyfile: - -```caddyfile -status.sami { - tls internal - - handle /api/* { - reverse_proxy localhost:3001 - } - - root * /path/to/sites/status - file_server -} -``` - -### 5. Access Dashboard - -Open your browser to: -``` -https://status.sami -``` - -## Documentation - -- **[Deployment Guide](DEPLOYMENT_GUIDE.md)** - Complete deployment instructions -- **[API Documentation](api/README.md)** - API server setup and configuration -- **[Caddyfile](C:/caddy/Caddyfile)** - Production Caddyfile example - -## Project Structure - -``` -status/ -├── index.html # Main dashboard page -├── apps.json # Service configuration -├── sw.js # Service worker for PWA -├── assets/ # Images, fonts, and static assets -├── api/ # Node.js API server -│ ├── caddy-api.js # Main API server -│ ├── package.json # Dependencies -│ ├── test-api.js # API test script -│ ├── start.bat # Windows startup script -│ ├── start.sh # Linux/macOS startup script -│ └── README.md # API documentation -├── DEPLOYMENT_GUIDE.md # Complete deployment guide -└── README.md # This file -``` - -## Key Technologies - -- **Frontend**: Vanilla JavaScript, HTML5, CSS3 -- **Backend**: Node.js, Express.js -- **Web Server**: Caddy v2 -- **DNS**: Technitium DNS Server -- **APIs**: - - Caddy Admin API (reverse proxy configuration) - - Technitium DNS API (DNS record management) - -## How App Deployment Works - -1. **User Input** - User selects app template and enters configuration (subdomain, IP, port) -2. **DNS Creation** - API creates A record in Technitium DNS -3. **Caddy Configuration** - API adds reverse proxy route via Caddy Admin API -4. **Instant Access** - App is immediately accessible at `https://subdomain.sami` -5. **Automatic Rollback** - If any step fails, previous changes are rolled back - -## Features in Detail - -### Service Monitoring -- HTTP/HTTPS status checks -- Response time tracking -- Visual status indicators -- Configurable check intervals - -### App Deployment -- Pre-configured app templates (Plex, Radarr, Sonarr, etc.) -- Custom app deployment -- Automatic DNS record creation -- Automatic Caddy reverse proxy configuration -- Internal CA or Let's Encrypt SSL -- Private or public DNS options - -### Weather Widget -- Current conditions -- Temperature and wind speed -- Location-based -- Configurable via settings - -### PWA Support -- Offline functionality -- Install to home screen -- App-like experience -- Service worker caching - -## API Endpoints - -| Method | Endpoint | Description | -|--------|----------|-------------| -| POST | `/api/apps/deploy` | Deploy a new app | -| POST | `/api/apps/delete` | Delete an app | -| GET | `/api/services` | Get list of services | -| GET | `/api/caddy/config` | Get Caddy configuration | -| GET | `/api/caddy/test` | Test API connectivity | -| GET | `/health` | Health check | - -## Configuration - -### Environment Variables - -- `CADDY_ADMIN_API` - Caddy Admin API URL (default: `http://localhost:2019`) -- `DNS_SERVER_API` - Technitium DNS API URL (default: `http://192.168.254.204:5380`) -- `TECHNITIUM_API_TOKEN` - API token for DNS operations (required) - -### Service Configuration - -Edit `apps.json` to add/remove services: - -```json -[ - { - "id": "myapp", - "name": "My App", - "logo": "assets/myapp.png", - "url": "https://myapp.sami" - } -] -``` - -## Browser Support - -- Chrome/Edge (latest) -- Firefox (latest) -- Safari (latest) -- Mobile browsers (iOS Safari, Chrome Mobile) - -## Security - -- CORS enabled (configure for production) -- API access restricted to localhost by default -- Environment-based configuration -- Input validation on all endpoints -- Automatic rollback on deployment failures - -## Troubleshooting - -See [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md#troubleshooting) for detailed troubleshooting steps. - -Common issues: -- **API not accessible**: Check if Node.js server is running -- **DNS not working**: Verify `TECHNITIUM_API_TOKEN` is set -- **Caddy routes not working**: Check Caddy Admin API is enabled - -## Contributing - -This is a personal project for SAMI-CLOUD infrastructure. Feel free to fork and adapt for your own use. - -## License - -MIT - -## Author - -SAMI-CLOUD diff --git a/status/index.html.backup-before-file-logs b/status/index.html.backup-before-file-logs deleted file mode 100644 index 942250e..0000000 --- a/status/index.html.backup-before-file-logs +++ /dev/null @@ -1,8125 +0,0 @@ - - - - - - SAMI-CLOUD Status - - - - - - - - - - - - - - - - - - - -
-
-
- SAMI-CLOUD logo -
- - -
-
-
-
🌤️
-
-
--
-
--°
-
--
-
--
- -
-
-
-
-
- - -
-
-
last check: —
- - - - - - - - - - -
-
-
- - -
-
- -
-
- - - - - - - - - - -
- DNS1 - - OFF -
-
- -- -
-
- - - - -
-
- -
- -
-
- - - - - - - - - - -
- DNS2 - - OFF -
-
- -- -
-
- - - - -
-
- -
- -
-
- - - - - - -
- Internet - - OFF -
-
- -- -
-
-
-
- - -
- -
- - -
- - -
- - -
- - -
-
-

Choose an App

-
-
- -
-
-
- - -
-
-

Deploy Application

- -
- -
- - -
- Your app will be available at: uptime.sami -
-
- - -
- -
- - - -
-
- - -
- -
- - - -
-
- - -
- -
- -
- Checking Tailscale status... -
-
-
- - -
- ⚙️ Advanced Options -
-
- - -
-
- - -
- Use 'localhost' for same-host containers, or specific IP for remote services -
-
-
-
-
- -
- - -
-
-
- - - - - -
-
-

Weather Settings

- - -
- - -
-
-
- - -
-
-
-

DNS Logs

-
- - - - -
-
-
-
-
Loading logs...
-
-
-
-
- - -
-
-

🔑 API Token Management

- -

- Configure API tokens for DNS services. Use read-only tokens for logs and admin tokens for restart operations. -

- - -
-

DNS1 (Windows)

-
-
- - -
- - -
-
-
- - -
- - -
-
-
-
-
- - -
-

DNS2 (Linux)

-
-
- - -
- - -
-
-
- - -
- - -
-
-
-
-
- -
- ℹ️ How to get API tokens -
-
    -
  1. Open Technitium DNS Admin Panel
    2. -
  2. Go to Settings → API
    3. -
  3. Create tokens with appropriate permissions: -
      -
    • Read-only: Enable only "Logs" permission
      • -
    • Admin: Enable "Administration" permission
      • -
    -
    4. -
  4. Copy the generated tokens here
    5. -
-
-
- -
- - - -
-
-
- - -
-
-

Edit Service

- -
- -
- -
-
-
-
-
- - -
- -
- - .sami -
-
- - -
- - -
- The port Caddy will proxy to (container's exposed port) -
-
- - -
- - -
- - -
- -
- - -
- -
- - -
-
- Enter a URL or upload an image file (PNG, JPG, SVG) -
-
-
- -
- - -
-
-
- - -
-
-
-

📋 Error Logs

-
- - - -
-
-
-
-
Loading error logs...
-
-
-
-
- - -
-
-

🔔 Notification Settings

- - -
- -
- - -

Notification Providers

- - -
-
- - -
- -
- - -
-
- - -
- -
- - -
-
- - -
- -
- - -

Health Monitoring

-
- -
- - - -
-
- Last check: Never -
-
- - -

Events to Notify

-
- - - - -
- - -

Notification History

-
-
No notifications yet
-
- - -
- - -
-
-
- - -
-
-

💾 Backup & Restore

-

- Export your DashCaddy configuration or restore from a previous backup. -

- - -
-

📤 Export Backup

-

- Download all your settings: services, Caddyfile, DNS credentials, notifications. -

- -
- - -
-

📥 Restore Backup

-

- Upload a backup file to restore your configuration. -

- - - -
- - - - - - - - -
- -
-
-
- - -
-
-

📊 Container Resources

-

- Real-time CPU, memory, and network usage for running containers. -

- - -
-
- Loading container stats... -
-
- - -
- - - -
- - -
- -
-
-
- - -
-
-

🎬 Arr Stack Integration

-

- Connect Overseerr to your Radarr and Sonarr instances. -

- - -
-
- ⏳ -
-
Overseerr
-
Checking...
-
-
-
- - - - - -
-

🌐 External Services (Seedbox)

- - -
-
- 🎬 - Radarr (Movies) - -
-
-
- - -
-
- - -
-
- -
- - -
-
- 📺 - Sonarr (TV Shows) - -
-
-
- - -
-
- - -
-
- -
- - - -
- - - - - -
- Where to find API keys:
- • Radarr: Settings → General → Security → API Key
- • Sonarr: Settings → General → Security → API Key -
- - -
- -
-
-
- - -
-
-

Add New Service

- - -
- -
- - -
-

- Local: Service running on your network (Docker, VM, etc.) -

-
- - -
- -
-

Service Configuration

- -
-
- - -
-
- - -
-
- -
-
- - -
-
- - -
- - - -
-
-
- - - -
- - -
-

DNS & SSL Configuration

- -
-
- -
-
- - -
-
- -
-

- DNS credentials are managed in the Tokens menu. -

- -
-
- - -
-
- - -
-
-
- - - - - - -
- - -
-

Tailscale Security

-
- Checking Tailscale status... -
- -
-
- - - - - -
- ⚙️ Advanced Options -
-
- - - - - - -
- -
- - - - - - - - -
-
-
- -
- -
- - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - -