fix(docs): contradictions from the review by mazzma12 · Pull Request #1174 · crowdsecurity/crowdsec-docs

mazzma12 · 2026-09-30T13:00:18Z

The other half of #1172, and the one that needs real checking: the high-severity and cross-section contradictions from the docs review — LAPI ports, the bouncer metrics payload shape, seats 3 → 5, systemd unit names, Kubernetes exec targets and challenge semantics — mirrored to the v1.6–v1.8 copies.
It also retires the Console "Troubleshooting Hints" page: sidebar entry removed, redirected to Stack Health, and the pages that linked to it updated.
Two claims still need someone with the sources: the CTI "22M+ observed IPs" figure and the haproxy captcha template path. 167 files, build passes with no broken anchors.

aikido-pr-checks · 2026-09-30T13:00:34Z

 # 5. Fetch the blocklist (using integration credentials)
-curl 'https://admin.api.crowdsec.net/v1/integrations/INTEGRATION_ID/content' \
-  -H 'x-api-key: INTEGRATION_API_KEY'
+curl -u 'USERNAME:PASSWORD' 'https://admin.api.crowdsec.net/v1/integrations/INTEGRATION_ID/content'


Exposed secret in crowdsec-docs/unversioned/tracker_api/api_integrations.mdx - low severity
Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.

_{Reply @AikidoSec ignore: [REASON] to ignore this issue.}
_{More Info}

aws-amplify-eu-west-1 · 2026-09-30T13:09:12Z

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-1174.d1to60jd2gb6y6.amplifyapp.com

Copilot

🟡 Changes recommended

Several links and JSON examples remain broken, and the Juniper retention and macOS volume instructions can cause operational failures.

12 open findings

Remove invalid comment from JSON payload · New
Use version-aware relative link for log processor · New
Point CTA to the existing blocklist document · New
Use a named volume for macOS Docker data persistence · New
Fix duplicate integrations path in relative link · New
Extend blocklist hold interval beyond refresh interval · New
Remove invalid comment from JSON payload · New
Use version-aware relative link for v1.6 docs · New
Remove invalid comment from JSON payload · New
Use version-aware relative link for v1.7 docs · New
Remove invalid comment from JSON payload · New
Use version-aware relative link for v1.8 docs · New

What changed in this PR

This PR corrects contradictory operational guidance across current, unversioned, and v1.6–v1.8 documentation, while retiring the obsolete Console troubleshooting page.

Changes:

Corrects configuration names, API payloads, ports, commands, and platform-specific instructions.
Synchronizes relevant corrections across maintained versioned documentation.
Redirects the retired troubleshooting page to Stack Health and updates references.

File	Description
`versioned_docs/version-v1.8/log_processor/service-discovery-setup/expr.md`	Corrects systemd unit names.
`versioned_docs/version-v1.8/log_processor/scenarios/format.md`	Clarifies bucket capacities.
`versioned_docs/version-v1.8/log_processor/parsers/format.md`	Corrects GeoIP method and link.
`versioned_docs/version-v1.8/log_processor/intro.mdx`	Updates acquisition guidance.
`versioned_docs/version-v1.8/log_processor/data_sources/loki.md`	Corrects Go duration.
`versioned_docs/version-v1.8/local_api/tls_auth.md`	Corrects LAPI port.
`versioned_docs/version-v1.8/local_api/profiles/format.md`	Corrects profile flow semantics.
`versioned_docs/version-v1.8/local_api/notification_plugins/writing_your_own_plugin.md`	Corrects plugin location.
`versioned_docs/version-v1.8/local_api/notification_plugins/intro.md`	Documents package-specific plugin paths.
`versioned_docs/version-v1.8/local_api/notification_plugins/gotify.md`	Fixes Gotify placeholder.
`versioned_docs/version-v1.8/getting_started/install_source.mdx`	Corrects RPM dependencies.
`versioned_docs/version-v1.8/getting_started/getting_started_on_windows.md`	Updates Windows runtime guidance.
`versioned_docs/version-v1.8/getting_started/crowdsec_tour.mdx`	Removes obsolete dashboard instructions.
`versioned_docs/version-v1.8/expr/other_helpers.md`	Corrects duration syntax.
`versioned_docs/version-v1.8/expr/event.md`	Corrects overflow event type.
`versioned_docs/version-v1.8/contributing/specs/bouncer_metrics_specs.mdx`	Corrects metrics payload shape.
`versioned_docs/version-v1.8/contributing/specs/bouncer_appsec_specs.mdx`	Updates bouncer and metrics specifications.
`versioned_docs/version-v1.8/configuration/network_management.md`	Expands proxy variables.
`versioned_docs/version-v1.8/configuration/crowdsec_configuration.md`	Corrects configuration fields.
`versioned_docs/version-v1.8/central_api/intro.md`	Corrects default sharing behavior.
`versioned_docs/version-v1.8/appsec/rules_syntax.md`	Corrects SecLang field name.
`versioned_docs/version-v1.8/appsec/rules_examples.md`	Corrects remediation example.
`versioned_docs/version-v1.8/appsec/quickstart/traefik.mdx`	Persists container data.
`versioned_docs/version-v1.8/appsec/quickstart/general.mdx`	Updates prerequisite and shell command.
`versioned_docs/version-v1.8/appsec/crs/installation.md`	Corrects acquisition keys.
`versioned_docs/version-v1.8/appsec/create_rules.md`	Updates minimum version.
`versioned_docs/version-v1.8/appsec/configuration_rule_management.md`	Clarifies allowlist behavior.
`versioned_docs/version-v1.8/appsec/bot_detection/hooks.md`	Corrects challenge semantics.
`versioned_docs/version-v1.8/appsec/bot_detection/enable.md`	Clarifies failed challenge testing.
`versioned_docs/version-v1.8/appsec/bot_detection/customization.md`	Corrects overlay configuration.
`versioned_docs/version-v1.8/appsec/api_validation.md`	Corrects filtered-route behavior.
`versioned_docs/version-v1.8/appsec/alerts_and_scenarios.md`	Corrects AND rule structure.
`versioned_docs/version-v1.7/log_processor/service-discovery-setup/expr.md`	Corrects systemd unit names.
`versioned_docs/version-v1.7/log_processor/scenarios/format.md`	Clarifies bucket capacities.
`versioned_docs/version-v1.7/log_processor/parsers/format.md`	Corrects GeoIP method and link.
`versioned_docs/version-v1.7/log_processor/intro.mdx`	Updates acquisition guidance.
`versioned_docs/version-v1.7/log_processor/data_sources/loki.md`	Corrects Go duration.
`versioned_docs/version-v1.7/local_api/tls_auth.md`	Corrects LAPI port.
`versioned_docs/version-v1.7/local_api/profiles/format.md`	Corrects profile flow semantics.
`versioned_docs/version-v1.7/local_api/notification_plugins/writing_your_own_plugin.md`	Corrects plugin location.
`versioned_docs/version-v1.7/local_api/notification_plugins/intro.md`	Documents package-specific plugin paths.
`versioned_docs/version-v1.7/getting_started/install_source.mdx`	Corrects RPM dependencies.
`versioned_docs/version-v1.7/getting_started/getting_started_on_windows.md`	Updates Windows runtime guidance.
`versioned_docs/version-v1.7/getting_started/crowdsec_tour.mdx`	Removes obsolete dashboard instructions.
`versioned_docs/version-v1.7/expr/other_helpers.md`	Corrects duration syntax.
`versioned_docs/version-v1.7/expr/event.md`	Corrects overflow event type.
`versioned_docs/version-v1.7/contributing/specs/bouncer_metrics_specs.mdx`	Corrects metrics payload shape.
`versioned_docs/version-v1.7/contributing/specs/bouncer_appsec_specs.mdx`	Updates bouncer and metrics specifications.
`versioned_docs/version-v1.7/configuration/network_management.md`	Expands proxy variables.
`versioned_docs/version-v1.7/configuration/crowdsec_configuration.md`	Corrects configuration fields.
`versioned_docs/version-v1.7/central_api/intro.md`	Corrects default sharing behavior.
`versioned_docs/version-v1.7/appsec/rules_syntax.md`	Corrects SecLang field name.
`versioned_docs/version-v1.7/appsec/rules_examples.md`	Corrects remediation example.
`versioned_docs/version-v1.7/appsec/quickstart/traefik.mdx`	Persists container data.
`versioned_docs/version-v1.7/appsec/quickstart/general.mdx`	Updates prerequisite and shell command.
`versioned_docs/version-v1.7/appsec/crs/installation.md`	Corrects acquisition keys.
`versioned_docs/version-v1.7/appsec/create_rules.md`	Updates minimum version.
`versioned_docs/version-v1.7/appsec/api_validation.md`	Corrects filtered-route behavior.
`versioned_docs/version-v1.7/appsec/alerts_and_scenarios.md`	Corrects AND rule structure.
`versioned_docs/version-v1.6/log_processor/scenarios/format.md`	Clarifies bucket capacities.
`versioned_docs/version-v1.6/log_processor/parsers/format.md`	Corrects GeoIP method and link.
`versioned_docs/version-v1.6/log_processor/data_sources/loki.md`	Corrects Go duration.
`versioned_docs/version-v1.6/local_api/tls_auth.md`	Corrects LAPI port.
`versioned_docs/version-v1.6/local_api/profiles/format.md`	Corrects profile flow semantics.
`versioned_docs/version-v1.6/local_api/notification_plugins/writing_your_own_plugin.md`	Corrects plugin location.
`versioned_docs/version-v1.6/local_api/notification_plugins/intro.md`	Documents package-specific plugin paths.
`versioned_docs/version-v1.6/local_api/notification_plugins/gotify.md`	Fixes Gotify placeholder.
`versioned_docs/version-v1.6/getting_started/install_source.mdx`	Corrects RPM dependencies.
`versioned_docs/version-v1.6/getting_started/getting_started_on_windows.md`	Updates Windows runtime guidance.
`versioned_docs/version-v1.6/expr/other_helpers.md`	Corrects duration syntax.
`versioned_docs/version-v1.6/expr/event.md`	Corrects overflow event type.
`versioned_docs/version-v1.6/contributing/specs/bouncer_metrics_specs.mdx`	Corrects metrics payload shape.
`versioned_docs/version-v1.6/contributing/specs/bouncer_appsec_specs.mdx`	Updates bouncer and metrics specifications.
`versioned_docs/version-v1.6/configuration/crowdsec_configuration.md`	Corrects configuration fields.
`versioned_docs/version-v1.6/central_api/intro.md`	Corrects default sharing behavior.
`versioned_docs/version-v1.6/appsec/rules_syntax.md`	Corrects SecLang field name.
`versioned_docs/version-v1.6/appsec/quickstart/general.mdx`	Updates prerequisite and shell command.
`versioned_docs/version-v1.6/appsec/create_rules.md`	Updates minimum version.
`versioned_docs/version-v1.6/appsec/alerts_and_scenarios.md`	Corrects AND rule structure.
`unversioned/user_guides/waf_rp_howto.md`	Corrects example destination IP.
`unversioned/user_guides/replay_mode.md`	Removes obsolete Metabase guidance.
`unversioned/user_guides/cscli_macos.md`	Updates build and architecture guidance.
`unversioned/user_guides/consuming_fastly_logs.md`	Corrects acquisition paths.
`unversioned/troubleshooting/security_engine.mdx`	Corrects sharing, storage, and proxy guidance.
`unversioned/troubleshooting/issue_se_too_many_alerts.md`	Targets Kubernetes agents.
`unversioned/troubleshooting/issue_se_self_report.md`	Targets Kubernetes agents.
`unversioned/troubleshooting/issue_se_offline.md`	Corrects threshold, workload, logs, and proxy setup.
`unversioned/troubleshooting/issue_se_no_alerts.md`	Corrects Kubernetes diagnostics and fixes.
`unversioned/troubleshooting/issue_lp_offline.md`	Corrects agent restart and TLS path.
`unversioned/troubleshooting/issue_integration_rc_offline.md`	Corrects integration endpoint guidance.
`unversioned/troubleshooting/issue_capi_403.md`	Updates paid-plan wording.
`unversioned/troubleshooting/intro.md`	Updates plan terminology.
`unversioned/tracker_api/guide_triage.mdx`	Separates insufficient-data guidance.
`unversioned/tracker_api/guide_proactive.mdx`	Requests detailed CVE data.
`unversioned/tracker_api/api_integrations.mdx`	Corrects integration authentication.
`unversioned/integrations/juniper.mdx`	Corrects Juniper feed configuration.
`unversioned/integrations/intro.mdx`	Updates refresh limits.
`unversioned/integrations/checkpoint.mdx`	Clarifies Check Point format selection.
`unversioned/getting_started/post_installation/whitelists.mdx`	Updates Premium terminology.
`unversioned/getting_started/post_installation/profiles.mdx`	Corrects Helm upgrade command.
`unversioned/getting_started/post_installation/console.mdx`	Clarifies plan requirements.
`unversioned/getting_started/post_installation/acquisition_new.mdx`	Corrects commands and Windows configuration.
`unversioned/getting_started/installation/windows.mdx`	Updates Windows runtime and installer guidance.
`unversioned/getting_started/installation/macos.mdx`	Adds persistent container data.
`unversioned/getting_started/installation/kubernetes.mdx`	Corrects secret key example.
`unversioned/getting_started/installation/cloudways.mdx`	Corrects machine and user-unit instructions.
`unversioned/getting_started/health_check.mdx`	Corrects proxy configuration.
`unversioned/cti_api/search_queries.md`	Corrects negated country query.
`unversioned/cti_api/api_integration/integration_securitycopilot.md`	Updates CTI dataset claim.
`unversioned/cti_api/api_integration/integration_msticpy.md`	Corrects YAML indentation.
`unversioned/console/service_api/integrations.mdx`	Adds supported vendor formats.
`unversioned/console/security_engines/troubleshooting.md`	Removes obsolete page.
`unversioned/console/security_engines/select_multiple_organizations.md`	Removes obsolete troubleshooting reference.
`unversioned/console/security_engines/details_page.md`	Removes obsolete troubleshooting reference.
`unversioned/console/security_engines/dashboard.mdx`	Links activity to Stack Health.
`unversioned/console/premium_upgrade/testing_premium.mdx`	Updates blocklist and seat limits.
`unversioned/console/premium_upgrade/optimal_setup.mdx`	Updates Community and seat limits.
`unversioned/console/premium_upgrade/features_overview.mdx`	Updates Premium comparisons.
`unversioned/console/premium_upgrade.mdx`	Updates seats, blocklists, and API quotas.
`unversioned/console/ip_reputation/intro.mdx`	Corrects tracker API-key guidance.
`unversioned/console/blocklists/subscription.md`	Updates Premium upgrade link.
`unversioned/bouncers/openresty.mdx`	Corrects paths, defaults, and variables.
`unversioned/bouncers/nginx.mdx`	Corrects SSL verification default.
`unversioned/bouncers/magento.mdx`	Corrects PHP configuration syntax.
`unversioned/bouncers/haproxy.mdx`	Corrects HAProxy template paths.
`unversioned/bouncers/haproxy_spoa.mdx`	Corrects decision origin.
`unversioned/bouncers/firewall.mdx`	Corrects bouncer creation command.
`unversioned/bouncers/custom.mdx`	Corrects retry option name.
`unversioned/blocklists/intro.md`	Corrects update-frequency wording.
`unversioned/blocklists/getting_started.mdx`	Clarifies free blocklist coverage.
`unversioned/beta_program.mdx`	Updates plan terminology.
`src/pages/index.tsx`	Updates CTI dataset claim.
`src/components/docs/PromoCard/index.tsx`	Updates CTI promotional claim.
`sidebarsUnversioned.ts`	Removes obsolete sidebar entry.
`docusaurus.config.ts`	Adds Stack Health redirects.
`docs/log_processor/service-discovery-setup/expr.md`	Corrects systemd unit names.
`docs/log_processor/scenarios/format.md`	Clarifies bucket capacities.
`docs/log_processor/parsers/format.md`	Corrects GeoIP method and link.
`docs/log_processor/intro.mdx`	Updates acquisition guidance.
`docs/log_processor/data_sources/loki.md`	Corrects Go duration.
`docs/local_api/tls_auth.md`	Corrects LAPI port.
`docs/local_api/profiles/format.md`	Corrects profile flow semantics.
`docs/local_api/notification_plugins/writing_your_own_plugin.md`	Corrects plugin location.
`docs/local_api/notification_plugins/intro.md`	Documents package-specific plugin paths.
`docs/local_api/notification_plugins/gotify.md`	Fixes Gotify placeholder.
`docs/getting_started/install_source.mdx`	Corrects RPM dependencies.
`docs/getting_started/getting_started_on_windows.md`	Updates Windows runtime guidance.
`docs/getting_started/crowdsec_tour.mdx`	Removes obsolete dashboard instructions.
`docs/expr/other_helpers.md`	Corrects duration syntax.
`docs/expr/event.md`	Corrects overflow event type.
`docs/contributing/specs/bouncer_metrics_specs.mdx`	Corrects metrics payload shape.
`docs/contributing/specs/bouncer_appsec_specs.mdx`	Updates bouncer and metrics specifications.
`docs/configuration/network_management.md`	Expands proxy variables.
`docs/configuration/crowdsec_configuration.md`	Corrects configuration fields.
`docs/central_api/intro.md`	Corrects default sharing behavior.
`docs/appsec/rules_syntax.md`	Corrects SecLang field name.
`docs/appsec/rules_examples.md`	Corrects remediation example.
`docs/appsec/quickstart/traefik.mdx`	Persists container data.
`docs/appsec/quickstart/general.mdx`	Updates prerequisite and shell command.
`docs/appsec/crs/installation.md`	Corrects acquisition keys.
`docs/appsec/create_rules.md`	Updates minimum version.
`docs/appsec/configuration_rule_management.md`	Clarifies allowlist behavior.
`docs/appsec/bot_detection/hooks.md`	Corrects challenge semantics.
`docs/appsec/bot_detection/enable.md`	Clarifies failed challenge testing.
`docs/appsec/bot_detection/customization.md`	Corrects overlay configuration.
`docs/appsec/api_validation.md`	Corrects filtered-route behavior.
`docs/appsec/alerts_and_scenarios.md`	Corrects AND rule structure.

🧠 Review effort: Balanced

Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

-                           "remediation_type": "ban"
-			},
-			"unit": "request"
+	"feature_flags": [], //Always empty / invalid / ignored for bouncers


 ```

-> `method: GeoIPCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See (Enrichers|parsers/enricher.md) for more information
+> `method: GeoIpCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See [Enrichers](/log_processor/parsers/enricher.md) for more information


+		after: "Premium: top 60k (×4)"
 	}}
-	link="/docs/central_api/community_blocklist/#community-blocklist-lite"
+	link="/docs/central_api/community_blocklist/#community-blocklist-premium"



 ```bash
-docker run -d --name crowdsec -v /var/run/docker.sock:/var/run/docker.sock -v /etc/crowdsec:/etc/crowdsec -v /var/log:/var/log crowdsecurity/crowdsec
+docker run -d --name crowdsec -v /var/run/docker.sock:/var/run/docker.sock -v /etc/crowdsec:/etc/crowdsec -v /var/lib/crowdsec/data:/var/lib/crowdsec/data -v /var/log:/var/log crowdsecurity/crowdsec


+For firewall integrations, pulling more frequently than the allowed interval for your plan will result in HTTP 429.
 :::

+These limits don't apply to [Remediation Component](integrations/remediationcomponent.mdx) integrations, which can poll at the bouncer's default interval on every plan.


 ```

-> `method: GeoIPCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See (Enrichers|parsers/enricher.md) for more information
+> `method: GeoIpCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See [Enrichers](/log_processor/parsers/enricher.md) for more information


-                           "remediation_type": "ban"
-			},
-			"unit": "request"
+	"feature_flags": [], //Always empty / invalid / ignored for bouncers


 ```

-> `method: GeoIPCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See (Enrichers|parsers/enricher.md) for more information
+> `method: GeoIpCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See [Enrichers](/log_processor/parsers/enricher.md) for more information


-                           "remediation_type": "ban"
-			},
-			"unit": "request"
+	"feature_flags": [], //Always empty / invalid / ignored for bouncers


 ```

-> `method: GeoIPCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See (Enrichers|parsers/enricher.md) for more information
+> `method: GeoIpCity` will use GeoIpCity to populate some fields in the `Enriched` entry. See [Enrichers](/log_processor/parsers/enricher.md) for more information


fix(docs): resolve contradictions from the documentation review

63f3876

mazzma12 mentioned this pull request Sep 30, 2026

fix(docs): resolve high-severity contradictions and wrong links from the review #1172

Closed

aikido-pr-checks Bot reviewed Sep 30, 2026

View reviewed changes

Merge branch 'main' into fix/docs-review-split-contradictions

c8056cf

mazzma12 requested review from sabban and a balanced review from Copilot October 8, 2026 08:05

Copilot started reviewing on behalf of mazzma12 October 8, 2026 08:05 View session

Copilot AI reviewed Oct 8, 2026

View reviewed changes

Navigation Menu

Repository navigation

fix(docs): contradictions from the review - #1174

fix(docs): contradictions from the review#1174
mazzma12 wants to merge 2 commits into
mainfrom
fix/docs-review-split-contradictions

mazzma12 commented Sep 30, 2026

Uh oh!

aikido-pr-checks Bot Sep 30, 2026

Uh oh!

aws-amplify-eu-west-1 Bot commented Sep 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

mazzma12 commented Sep 30, 2026

Uh oh!

aikido-pr-checks Bot Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

aws-amplify-eu-west-1 Bot commented Sep 30, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants