vrr/DockFlare
2
0
Fork 0
mirror of https://github.com/ChrispyBacon-dev/DockFlare.git synced 2026-04-28 03:39:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

v3.0.3 - doc updates
Some checks are pending
Docker Image Build and Push / build_self_hosted (push) Waiting to run
Details
Docker Image Build and Push / build_github_hosted_fallback (push) Blocked by required conditions
Details

Browse source
This commit is contained in:
ChrispyBacon-dev 2025-10-04 20:34:48 +02:00
parent 640eac40dd
commit 68f34a0697
8 changed files with 71 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

9
dockflare/app/templates/docs/Using-the-Web-UI.md
View file

@ -11,7 +11,7 @@ The first page you see after logging in is the main dashboard. This is your cent
* **Service:** The internal destination URL.
* **Source:** Indicates if the rule is from `Docker` or was created `Manually` in the UI.
* **Status:** Shows if the rule is `active`, `pending_deletion`, or has a `UI Override`.
* **Access:** Displays the Access Policy applied to the rule (e.g., `Public`, `Authenticate`, or the name of an Access Group).
* **Access:** Displays the applied Access Group and mode badge. Expect to see `Public` or `Authenticated` labels, cascaded group names, and quick links to the Cloudflare dashboard when reusable policies sync.
* **Manage Rule:** This button allows you to edit any rule.
* **Real-time Logs:** Below the table, you'll find a real-time log viewer that streams logs from the DockFlare backend, which is invaluable for debugging.
@ -26,9 +26,10 @@ The UI gives you full control over your ingress rules.
## Access Policies Page
This page is the central location for managing your reusable **Access Groups**. From here, you can:
* **Create** new Access Groups with complex rules (e.g., based on email, IP, or country).
* **Edit** existing Access Groups.
* **Delete** Access Groups that are no longer in use.
* **Create** new Access Groups using the two-tab modal (Authenticated vs Public). Guidance banners update per tab so you understand when DockFlare will emit a Cloudflare `allow` or `bypass` decision.
* **Edit** existing Access Groups. The modal enforces mode-specific validation (emails required for Authenticated) and keeps Geo/IP settings visible for both modes.
* **Delete** Access Groups that are no longer in use. DockFlare keeps track of the linked reusable Cloudflare policy and removes it when you drop the group.
* Use the action menu beside each entry to open the matching policy directly in the Cloudflare dashboard via the Cloudflare icon shortcut.
For more details, see the [Access Policy Best Practices & Examples](Access-Policy-Best-Practices.md) guide.