Enhance Docker setup and documentation

- Update .dockerignore to exclude sources configuration files
- Add Docker deployment instructions in DOCKER_DEPLOYMENT.md
- Modify Dockerfile to clarify sources.yaml mounting
- Update docker-compose files to mount sources.yaml and tmpfw directory
- Implement health check endpoint in docker-compose configurations
- Add error handling for missing sources.yaml in docker-entrypoint.sh
- Remove outdated firmware flashing scripts
- Introduce new sources_example.yaml with example firmware configurations

Author: the78mole

.dockerignore

@@ -3,6 +3,11 @@
 .gitignore
 .github
 
+# Sources configuration files (must be mounted from outside)
+sources.yaml
+sources_example.yaml
+sources*.yaml
+
 # Python
 __pycache__
 *.pyc

DOCKER_DEPLOYMENT.md

@@ -0,0 +1,86 @@
+# Docker Deployment Instructions
+
+## Quick Start
+
+1. **Create your sources configuration:**
+   ```bash
+   cp sources_example.yaml sources.yaml
+   # Edit sources.yaml with your firmware repositories
+   ```
+
+2. **Start the container:**
+   ```bash
+   docker-compose up -d
+   ```
+
+3. **Access the web interface:**
+   Open http://localhost:8000 in your browser
+
+## Configuration Files
+
+### sources.yaml (Required)
+The `sources.yaml` file defines which firmware repositories to fetch from. It **must** be mounted from outside the container for security and flexibility.
+
+**Example:**
+```yaml
+fetchdir: ./tmpfw
+
+sources:
+  - type: github
+    platform: pio
+    name: my-firmware
+    repo: user/my-esp32-firmware
+    asset_pattern: "^firmware-esp32-${revision}.bin$"
+```
+
+### Volume Mounts
+
+| Host Path | Container Path | Description |
+|-----------|---------------|-------------|
+| `./sources.yaml` | `/app/sources.yaml:ro` | **Required** - Firmware source configuration |
+| `./tmpfw` | `/app/tmpfw` | Firmware download directory |
+| `./img` | `/app/img:ro` | Optional custom firmware images |
+| `/dev` | `/dev` | USB device access |
+
+## Docker Compose Files
+
+- `docker-compose.yml` - Development setup with live reload
+- `docker-compose.production.yml` - Production setup with published image
+- `docker-compose.production-pinned.yml` - Production with pinned version
+- `docker-compose.production-secure.yml` - Production with limited device access
+- `examples/docker-compose.extended.yml` - Extended setup with custom features
+
+## Security Notes
+
+- The `sources.yaml` file is **never** included in the Docker image
+- Always mount it as read-only (`:ro`)
+- Use `docker-compose.production-secure.yml` for production environments
+- Consider running without `privileged: true` by mapping specific TTY devices
+
+## Troubleshooting
+
+### Container fails to start with "sources.yaml not found"
+```bash
+# Make sure you have a sources.yaml file in your current directory
+ls -la sources.yaml
+
+# If not, create one from the example
+cp sources_example.yaml sources.yaml
+```
+
+### No firmware appears in web interface
+```bash
+# Check if tmpfw directory has content
+ls -la tmpfw/
+
+# Check container logs
+docker-compose logs webuiflasher
+```
+
+### USB devices not detected
+```bash
+# Check if devices are mapped correctly
+docker-compose exec webuiflasher ls -la /dev/ttyUSB* /dev/ttyACM*
+
+# For secure setup, adjust device mappings in docker-compose.production-secure.yml
+```

Dockerfile

@@ -18,7 +18,7 @@ WORKDIR /app
 # Copy project files
 COPY pyproject.toml uv.lock ./
 COPY scripts/ ./scripts/
-COPY sources.yaml ./
+# NOTE: sources.yaml and sources_example.yaml are NOT copied - they must be mounted from outside
 COPY img/ ./img/
 COPY README.md ./
 COPY docker-entrypoint.sh ./
@@ -41,7 +41,7 @@ EXPOSE 8000
 
 # Add healthcheck
 HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
-  CMD curl -f http://localhost:8000/api/firmware || exit 1
+  CMD curl -f http://localhost:8000/health || exit 1
 
 # Set entrypoint (using root for better device access)
 ENTRYPOINT ["./docker-entrypoint.sh"]

docker-compose.production-pinned.yml

@@ -1,24 +1,27 @@
 version: '3.8'
 
-    healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
-      interval: 30s
-      timeout: 10s
-      retries: 3
-      start_period: 40ses:
+services:
   webuiflasher:
-    image: ghcr.io/the78mole/webuiflasher:v1.0.0
+    image: ghcr.io/the78mole/webuiflasher:v0.0.9
     container_name: webuiflasher-pinned
     ports:
       - "8000:8000"
     volumes:
-      - ./firmware:/app/firmware
-      - ./sources:/app/sources
+      # Mount firmware download directory
+      - ./tmpfw:/app/tmpfw
+      # Mount sources configuration (external injection)
+      - ./sources.yaml:/app/sources.yaml:ro
+      # Optional: Mount custom firmware sources
+      - ./img:/app/img:ro
+      # Mount entire /dev for USB access
       - /dev:/dev
     privileged: true
     restart: unless-stopped
     environment:
       - TZ=Europe/Berlin
+      - PYTHONUNBUFFERED=1
+      - WEBFLASHER_HOST=0.0.0.0
+      - WEBFLASHER_PORT=8000
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
       interval: 30s

docker-compose.production-secure.yml

@@ -7,15 +7,22 @@ services:
     ports:
       - "8000:8000"
     volumes:
-      - ./firmware:/app/firmware
-      - ./sources:/app/sources
+      # Mount firmware download directory
+      - ./tmpfw:/app/tmpfw
+      # Mount sources configuration (external injection)
+      - ./sources.yaml:/app/sources.yaml:ro
+      # Optional: Mount custom firmware sources
+      - ./img:/app/img:ro
       # Specific TTY devices only (adjust as needed)
       - /dev/ttyUSB0:/dev/ttyUSB0
       - /dev/ttyUSB1:/dev/ttyUSB1
       - /dev/ttyACM0:/dev/ttyACM0
     restart: unless-stopped
     environment:
       - TZ=Europe/Berlin
+      - PYTHONUNBUFFERED=1
+      - WEBFLASHER_HOST=0.0.0.0
+      - WEBFLASHER_PORT=8000
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
       interval: 30s

docker-compose.production.yml

@@ -7,13 +7,21 @@ services:
     ports:
       - "8000:8000"
     volumes:
-      - ./firmware:/app/firmware
-      - ./sources:/app/sources
+      # Mount firmware download directory
+      - ./tmpfw:/app/tmpfw
+      # Mount sources configuration (external injection)
+      - ./sources.yaml:/app/sources.yaml:ro
+      # Optional: Mount custom firmware sources
+      - ./img:/app/img:ro
+      # Mount entire /dev for USB access
       - /dev:/dev
     privileged: true
     restart: unless-stopped
     environment:
       - TZ=Europe/Berlin
+      - PYTHONUNBUFFERED=1
+      - WEBFLASHER_HOST=0.0.0.0
+      - WEBFLASHER_PORT=8000
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
       interval: 30s

docker-entrypoint.sh

@@ -19,6 +19,17 @@ else
     echo "⚠️  No USB devices found. Make sure devices are mapped in docker-compose.yml"
 fi
 
+# Check if sources.yaml exists (must be mounted from outside)
+if [ ! -f "/app/sources.yaml" ]; then
+    echo "❌ ERROR: sources.yaml not found!"
+    echo "💡 You must mount a sources.yaml file from outside the container:"
+    echo "   -v ./your-sources.yaml:/app/sources.yaml:ro"
+    echo "📝 See sources_example.yaml for reference"
+    exit 1
+else
+    echo "✅ Found sources.yaml configuration"
+fi
+
 # Download firmware if tmpfw is empty
 if [ ! "$(ls -A /app/tmpfw 2>/dev/null)" ]; then
     echo "📥 Downloading firmware..."

examples/docker-compose.extended.yml

@@ -9,13 +9,21 @@ services:
     ports:
       - "8000:8000"
     volumes:
-      - ./firmware:/app/firmware
-      - ./sources:/app/sources
+      # Mount firmware download directory
+      - ./tmpfw:/app/tmpfw
+      # Mount sources configuration (external injection)
+      - ./sources.yaml:/app/sources.yaml:ro
+      # Optional: Mount custom firmware sources
+      - ./img:/app/img:ro
+      # Mount entire /dev for USB access
       - /dev:/dev
     privileged: true
     restart: unless-stopped
     environment:
       - TZ=Europe/Berlin
+      - PYTHONUNBUFFERED=1
+      - WEBFLASHER_HOST=0.0.0.0
+      - WEBFLASHER_PORT=8000
       - WEBUI_TITLE=My Custom ESP Flasher
       - WEBUI_THEME=dark
     healthcheck: