Quick‐Start‐Docker‐Compose.md

Quick Start (Using Docker Compose)

This guide provides the quickest way to get DockFlare running using Docker Compose.

1. Create docker-compose.yml

Create a file named docker-compose.yml with the following content. This defines the DockFlare service, its network, and a volume for persistent state.

version: '3.8'
services:
  dockflare:
    image: alplat/dockflare:stable # Use the desired image tag
    container_name: dockflare
    restart: unless-stopped
    ports:
      - "5000:5000"  # Exposes the Web UI on port 5000
    env_file:
      - .env        # Loads configuration from the .env file
    volumes:
      # Required to monitor Docker container events
      - /var/run/docker.sock:/var/run/docker.sock:ro
      # Persistent storage for state.json (managed rules, deletion timers)
      - dockflare_data:/app/data
    networks:
      # Network for communication with the managed cloudflared agent
      - cloudflare-net

volumes:
  # Define the persistent volume
  dockflare_data:

networks:
  # Define the network used by DockFlare and its managed agent
  cloudflare-net: