dozzle/README.md
GeorgeWebberley 8a0e729eb6
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Added README
2026-02-02 20:56:53 +01:00

1.5 KiB

Dozzle Deployment

This repository contains the deployment configuration for Dozzle, a real-time, responsive log viewer for Docker containers. It provides a lightweight web interface to monitor container logs without needing to access the CLI.

🏗️ Architecture Overview

  • Service: Dozzle (Real-time Log Viewer)
  • Networking: Integrated into the web_traffic external network to allow access via your reverse proxy.
  • Security: Mounts the Docker socket in read-only mode to stream logs to the dashboard.
  • CI/CD: Automated deployment via Woodpecker CI on every push to the main branch.

📂 Repository Structure

  • docker-compose.yaml: Defines the Dozzle service and ensures it has access to /var/run/docker.sock.
  • .woodpecker.yaml: Handles the automated deployment to the host server directory.

🚀 Deployment

Manual Setup

Ensure the web_traffic network exists before launching the stack:

docker network create web_traffic
docker compose up -d

CI/CD Workflow

The Woodpecker pipeline automates the following on every push:

  • Ensures the deployment directory /home/george/dozzle exists on the host.
  • Syncs the repository files to the server.
  • Executes a docker compose up -d with --pull always and --force-recreate to ensure the dashboard is running the latest version.

🛠️ Usage

Once deployed and configured in your reverse proxy (e.g., Caddy), you can view all running container logs through the web UI. Dozzle does not store any logs; it simply streams them directly from the Docker daemon.