Skip to content

CrowdSec: report usage facts to phonehome #8220

Closed
Feature
Closed
CrowdSec: report usage facts to phonehome#8220
Feature
Labels
verifiedAll test cases were verified successfully
Milestone
NethServer 8.10

Description

@gsanchietti
gsanchietti
opened on Oct 9, 2026

Today phonehome only knows that CrowdSec is installed.

Add CrowdSec info inside the phonehome, like other NethServer 8 apps already do.

Proposed solution

Add a get-facts action to the CrowdSec app that returns a summary of its configuration:

  • how bans work: longer bans for repeat offenders, and whether local network addresses can be banned
  • whether the app is connected to the CrowdSec community service, gets the community blocklist and is enrolled in the CrowdSec console
  • whether the NethVoice protection rules are enabled
  • whether email notifications are set up
  • how many entries the whitelist has
  • which Threat Shield enterprise lists are enabled

See also

Activity

  1. gsanchietti
    added the
    Feature
    issue type on Oct 9, 2026
  2. gsanchietti
    added this to NethServeron Oct 9, 2026

  3. gsanchietti commented on Oct 9, 2026

    @gsanchietti
    gsanchietti
    on Oct 9, 2026
    MemberAuthor

    Testing versions: crowdsec:1.4.0-dev.1

    Fresh install:

    add-module ghcr.io/nethserver/crowdsec:1.4.0-dev.1 1

    Update an existing instance (from 1.3.0):

    update-module ghcr.io/nethserver/crowdsec:1.4.0-dev.1 crowdsec1

    Test case 1: clean install

    • Install CrowdSec on a new cluster.
    • On the leader node, show the CrowdSec entry in the phonehome data: 
      runagent print-phonehome | jq '.facts.modules[] | select(.module == "crowdsec")'
    • Check the entry includes the CrowdSec facts, and that their values match the app's settings.

    Test case 2: update from 1.3.0

    • Start from CrowdSec 1.3.0. If you want, change some settings from the defaults.
    • Update to the test version.
    • Execute again the print-phonehome command as in test case 1
  4. gsanchietti
    added
    testingPackages are available from testing repositories
    on Oct 9, 2026
  5. nethbot
    moved this from ToDo to Testing in NethServeron Oct 9, 2026
  6. gsanchietti
    added this to the NethServer 8.10 milestone on Oct 9, 2026
  7. stephdl
    self-assigned this
    on Oct 9, 2026

  8. stephdl commented on Oct 9, 2026

    @stephdl
    stephdl
    on Oct 9, 2026

    QA ok on crowdsec:1.4.0-dev.1.

    Clean install

    The phonehome entry has the CrowdSec facts. They match the default settings.

    Update from 1.3.0

    I changed every setting before the update. After it, the facts match the new values.

    Older CrowdSec instances, without get-facts, still show up in phonehome. They just have no facts.

    One catch

    console_enrolled can read true after a rejected enroll key. This bug is older than this issue, so I track it apart:

  9. stephdl
    moved this from Testing to Verified in NethServeron Oct 9, 2026
  10. stephdl
    added
    verifiedAll test cases were verified successfully
    and removed
    testingPackages are available from testing repositories
    on Oct 9, 2026
  11. nethbot
    moved this from In Progress to Verified in NethServeron Oct 9, 2026

  12. DavidePrincipi commented on Oct 9, 2026

    @DavidePrincipi
    DavidePrincipi
    on Oct 9, 2026
    Member

    Released https://github.com/NethServer/ns8-crowdsec/releases/tag/1.4.0

  13. DavidePrincipi
    closed this as completedon Oct 9, 2026
  14. github-project-automation
    moved this from Verified to Done in NethServeron Oct 9, 2026
  15. DavidePrincipi
    unassigned
    stephdl
    on Oct 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    verifiedAll test cases were verified successfully

    Type

    Feature

    Projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions