UsingtheWebUI.md

Using the Web UI

DockFlare includes a built-in web interface that provides visibility into its status and allows for basic management tasks.

Access: How to Access the Web UI (Typically http://localhost:5000)

(Note: Ensure the image path is correct or upload the image directly to the wiki)

The UI is primarily divided into these sections:

1. Status Dashboard

Located at the top, this section provides a quick overview:

• DockFlare Status: Indicates the overall health or initialization state of the DockFlare application itself.
• Tunnel Status: Shows whether DockFlare has successfully connected to or created the configured Cloudflare Tunnel. Statuses might include "Connected", "Creating", "Error", etc.
• Agent Status (Internal Mode Only): Displays the status of the cloudflared agent container that DockFlare manages when running in the default Internal Mode. Statuses might include "Running", "Stopped", "Starting", "Error". This section is hidden or indicates "External" when running in External Mode.

2. Agent Controls (Internal Mode Only)

• Start/Stop Buttons: If running in Internal Mode, buttons are available to manually start or stop the managed cloudflared agent container. This can be useful for troubleshooting tunnel connectivity without restarting DockFlare itself. These controls are disabled in External Mode.

3. Managed Ingress Rules

This table lists all the ingress rules currently known to DockFlare, based on container labels and persisted state.

• Hostname: The public hostname being managed.
• Service: The internal target service (protocol://host:port).
• Status:
  • Active: The rule is configured in Cloudflare and linked to a running container.
  • Pending Deletion: The associated container has stopped, and the rule is scheduled for deletion after the grace period.
  • Deleting: The rule is actively being deleted from Cloudflare.
  • Error: There was a problem configuring or deleting this rule. Check logs.
• Container ID: The short ID of the Docker container that generated this rule.
• Deletion Time: (Visible for Pending Deletion status) The timestamp when the grace period expires and the rule will be automatically deleted.
• Actions:
  • Force Delete: A button to immediately remove the rule from Cloudflare and DockFlare's state, bypassing any grace period. Use with caution, as it can disrupt service if the container is expected to restart.

4. Real-time Activity Logs

• Log Stream: This section displays logs directly from the DockFlare application in real-time using Server-Sent Events (SSE).
• Content: Shows container detection events, label processing, Cloudflare API interactions (tunnel creation, DNS updates, ingress rule changes), errors, and status updates.
• Usefulness: Essential for monitoring DockFlare's operations, diagnosing configuration issues, and understanding why a service might not be exposed as expected. See also Debugging & Logs.

Note on Reverse Proxies: If accessing the UI through a reverse proxy (like Nginx, Traefik, Caddy), ensure the proxy is configured to handle Server-Sent Events (SSE) correctly (e.g., no excessive buffering, appropriate timeouts) for the real-time log stream to function properly.