Skip to content

Improve self-hosted Traefik docs and CrowdSec observe-mode notes#710

Open
TechHutTV wants to merge 2 commits intomainfrom
update/docs-general-fixes
Open

Improve self-hosted Traefik docs and CrowdSec observe-mode notes#710
TechHutTV wants to merge 2 commits intomainfrom
update/docs-general-fixes

Conversation

@TechHutTV
Copy link
Copy Markdown
Collaborator

@TechHutTV TechHutTV commented Apr 22, 2026

Summary

Expands the self-hosted reverse proxy docs to cover the getting-started.sh Option 1 (Existing Traefik) flow and adds a troubleshooting section for installation script issues. Also updates CrowdSec docs so observe-mode behavior in the dashboard is documented and the migration guide reflects the current Access Control UI.

Changes made

src/pages/selfhosted/external-reverse-proxy.mdx

  • As a follow up to [self-hosted] fix(getting-started): Infinite healthcheck loop with existing traefik netbird#5871 we're adding a new Using the script with an existing Traefik (Option 1) subsection between New Deployments and Existing Deployments covering:
    • Prerequisites (running Traefik, Docker network, HTTPS entrypoint, cert resolver, DNS, ports 80/443)
    • The three prompts the script asks (network, entrypoint, cert resolver)
    • What the script generates and how the readiness probe works
    • Cross-link to the new troubleshooting section

src/pages/selfhosted/troubleshooting.mdx

  • Added a new top-level Installation Script Issues section between Embedded IdP Issues and Debugging TURN connections covering:
    • Script hangs on the readiness wait, with an ordered checklist (DNS, cert issuance, Docker socket access for option 1, network membership for option 1, end-to-end routing test)
    • Script exits because generated files already exist, with the cleanup commands to start fresh
  • Anchor #installation-script-issues matches the slug produced by @sindresorhus/slugify used in mdx/rehype.mjs.

src/pages/manage/reverse-proxy/access-logs.mdx

  • Documented that observe-mode entries render with a badge in the dashboard and show the underlying decision type (ban, captcha, throttle, unavailable) on hover.
  • Added a link to the CrowdSec self-test workflow.

src/pages/manage/reverse-proxy/authentication.mdx

  • Updated the Observe mode row in the CrowdSec modes table to mention the observe-mode badge and link to the auditing workflow.

src/pages/selfhosted/migration/enable-reverse-proxy.mdx

  • Updated the per-service enablement instructions to point at Access Control (removed the stale > Access Restrictions path).
  • Added a CrowdSec IP Reputation overview screenshot.

@TechHutTV TechHutTV changed the title Docs General Updates Improve self-hosted Traefik docs and CrowdSec observe-mode notes Apr 27, 2026
@TechHutTV TechHutTV marked this pull request as ready for review April 27, 2026 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants