HealthChecks.md

Troubleshooting: Health Checks

DockFlare provides a couple of basic HTTP endpoints that can be used for health checking or simple diagnostics. These are served by the same web server as the main UI (default port 5000).

/ping Endpoint

• URL: http://<dockflare-host>:5000/ping
• Purpose: Provides a very basic health check of the DockFlare web server itself.
• Response: If the DockFlare application's web server is running and able to respond, it will typically return a simple JSON response indicating success, often including basic application status or version info. Example (actual content may vary):

  {
    "status": "ok",
    "message": "pong",
    "version": "x.y.z"
  }

• Use Case: Can be used by monitoring systems (like uptime checkers or Docker health checks if configured) to verify that the DockFlare process is running and responsive at the HTTP level. It does not guarantee that DockFlare is successfully connected to Docker or Cloudflare.

/cloudflare-ping Endpoint

• URL: http://<dockflare-host>:5000/cloudflare-ping
• Purpose: Attempts to make a simple, authenticated request to the Cloudflare API using the configured credentials (CF_API_TOKEN, CF_ACCOUNT_ID). This helps verify that DockFlare can reach the Cloudflare API and that the credentials are fundamentally valid (though not necessarily that they have the correct permissions).
• Response:
  • Success: Returns a JSON response indicating successful connection to the Cloudflare API, potentially including details like the authenticated account ID. Example:

    {
      "status": "success",
      "message": "Successfully connected to Cloudflare API.",
      "account_id": "your_cloudflare_account_id"
    }

  • Failure: Returns a JSON response indicating an error, often including the reason (e.g., authentication failure, network error). Example:

    {
      "status": "error",
      "message": "Failed to connect to Cloudflare API: Authentication error (Invalid API token?)"
    }

• Use Case: Useful for quickly diagnosing basic connectivity issues between DockFlare and Cloudflare, or verifying that the API token is at least recognized by Cloudflare. It's a good first step if you suspect API credential problems, before diving deep into permission issues.

Note: Accessing these endpoints usually requires network access to port 5000 of the DockFlare container. If using Docker health checks, the check command would run inside the container's network namespace.