Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance: Add pull and sharing options in configuration #667

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions crowdsec-docs/docs/configuration/crowdsec_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,10 @@ api:
use_forwarded_for_headers: "<true|false>"
console_path: <path_to_console_file>
online_client:
sharing: "(true|false)"
pull:
community: "(true|false)"
blocklists: "(true|false)"
credentials_path: "<path_to_crowdsec_api_client_credential_file>"
disable_remote_lapi_registration: (true|false)
capi_whitelists_path: "<path_to_capi_whitelists_file>"
Expand Down Expand Up @@ -697,6 +701,10 @@ api:
use_forwarded_for_headers: "(true|false)"
console_path: <path_to_console_file>
online_client:
sharing: "(true|false)"
pull:
community: "(true|false)"
blocklists: "(true|false)"
credentials_path: "<path_to_crowdsec_api_client_credential_file>"
disable_remote_lapi_registration: (true|false)
capi_whitelists_path: "<path_to_capi_whitelists_file>"
Expand Down Expand Up @@ -803,6 +811,10 @@ server:
#- 10.0.0.0/24
console_path: <path_to_console_file>
online_client:
sharing: "(true|false)"
pull:
community: "(true|false)"
blocklists: "(true|false)"
credentials_path: <path_to_crowdsec_api_client_credential_file>
disable_remote_lapi_registration: (true|false)
capi_whitelists_path: "<path_to_capi_whitelists_file>"
Expand Down Expand Up @@ -876,9 +888,36 @@ Configuration to push signals and receive bad IPs from Crowdsec API.

```yaml
online_client:
sharing: "(true|false)"
pull:
community: "(true|false)"
blocklists: "(true|false)"
credentials_path: "<path_to_crowdsec_api_client_credential_file>"
```

###### `sharing`
> bool

Whether you want to share signals with Central API, please note as outlined in the [Community blocklists](central_api/blocklist.md) section, enabling or disabling based on your plan type will affect how many IP's are downloaded from the community blocklists.

###### `pull`

```yaml
pull:
community: "(true|false)"
blocklists: "(true|false)"
```

###### `community`
> bool

Whether to pull signals from the community blocklists. Useful when you want to share your signals with the community but don't want to receive signals from the community.

###### `blocklists`
> bool

Whether to pull signals from the CrowdSec blocklists. Useful when you want to share your signals with the community but don't want to receive signals from 3rd party or first party blocklists.

###### `credentials_path`
> string

Expand Down