DockFlare/dockflare/app/templates/docs/Quick-Start-Docker-Compose.md

Quick Start (Docker Compose)

This guide will walk you through the fastest way to get DockFlare up and running using Docker Compose.

1. Create the docker-compose.yml file

First, create a docker-compose.yml file with the following content. This configuration uses the stable image of DockFlare, maps the required Docker socket, and sets up a persistent volume for your configuration.

version: '3.8'
services:
  dockflare:
    image: alplat/dockflare:stable
    container_name: dockflare
    restart: unless-stopped
    ports:
      - "5000:5000" # Exposes the web UI
    volumes:
      # Mount the Docker socket (read-only)
      - /var/run/docker.sock:/var/run/docker.sock:ro
      
      # This volume is crucial for persisting your encrypted configuration
      - ./dockflare_data:/app/data
    networks:
      - cloudflare-net

# This volume stores your encrypted credentials and state
volumes:
  dockflare_data:

# It is recommended to use an external network for your services
networks:
  cloudflare-net:
   name: cloudflare-net
   external: true

Note: Before running the compose file, ensure the external network cloudflare-net exists. If not, you can create it with the command: docker network create cloudflare-net.

2. Run DockFlare

Once you have saved the docker-compose.yml file, you can start DockFlare with the following command:

docker compose up -d

This will pull the latest stable image and start the DockFlare container in the background.

3. Complete the Pre-Flight Setup

After starting the container, open your web browser and navigate to http://<your-server-ip>:5000.

You will be greeted by the Pre-Flight Setup Wizard. This one-time process will guide you through:

1. Creating a password for the Web UI.
2. Entering your Cloudflare credentials (Account ID, Zone ID, and API Token).
3. Configuring your initial Cloudflare Tunnel.

4. For Existing Users (Upgrading)

If you are upgrading from an older version of DockFlare that used a .env file, DockFlare will automatically detect it. You will be guided through a simple migration process to import your existing settings and create a password for the new secure setup.