Skip to content

Prerequisites.md

Chris edited this page May 18, 2025 · 7 revisions

Prerequisites

Before you begin setting up DockFlare, ensure you have the following prerequisites installed and configured:

  • Docker: DockFlare runs as a Docker container and interacts with the Docker daemon.
  • Docker Compose (Recommended): Simplifies the deployment and management of DockFlare and its potential dependencies.
  • Cloudflare Account: You need an active Cloudflare account.
  • Cloudflare API Token: DockFlare requires an API token to interact with your Cloudflare account.
    • Permissions Required: The token needs the following permissions:
    • API Token with Account:Cloudflare Tunnel:Edit, Account:Account Settings:Read, Account:Access: Apps and Policies:Edit, Zone:Zone:Read, Zone:DNS:Edit
      Cloudflare API
  • Cloudflare Account ID: Needed to identify your Cloudflare account.
    • How to find it: Log in to your Cloudflare Dashboard, select any domain, and find the Account ID listed in the Overview section on the right sidebar.
  • Cloudflare Zone ID: Needed to identify the default domain (zone) you want DockFlare to manage DNS records in. You can override this per-container using labels.
    • How to find it: Log in to your Cloudflare Dashboard, select the specific domain (zone) you want to use, and find the Zone ID listed in the Overview section on the right sidebar.
Clone this wiki locally