Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Manage alerts

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli alerts delete](/cscli/cscli_alerts_delete.md) - Delete alerts
/!\ This command can be use only on the same machine than the local API.
/!\ This command can be used only on the same machine than the local API.
* [cscli alerts flush](/cscli/cscli_alerts_flush.md) - Flush alerts
/!\ This command can be used only on the same machine than the local API
* [cscli alerts inspect](/cscli/cscli_alerts_inspect.md) - Show info about an alert
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_alerts_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: cscli alerts delete
## cscli alerts delete

Delete alerts
/!\ This command can be use only on the same machine than the local API.
/!\ This command can be used only on the same machine than the local API.

```
cscli alerts delete [filters] [--all] [flags]
Expand Down
6 changes: 3 additions & 3 deletions crowdsec-docs/docs/cscli/cscli_alerts_flush.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ cscli alerts flush --max-items 1000 --max-age 7d
### Options

```
--max-items int Maximum number of alert items to keep in the database (default 5000)
--max-age string Maximum age of alert items to keep in the database (default "7d")
-h, --help help for flush
--max-items int Maximum number of alert items to keep in the database (default 5000)
--max-age duration Maximum age of alert items to keep in the database (default 168h0m0s)
-h, --help help for flush
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_alerts_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ cscli alerts list --type ban

```
-a, --all Include decisions from Central API
--until string restrict to alerts older than until (ie. 4h, 30d)
--since string restrict to alerts newer than since (ie. 4h, 30d)
--until duration restrict to alerts older than until (ie. 4h, 30d) (default 0s)
--since duration restrict to alerts newer than since (ie. 4h, 30d) (default 0s)
-i, --ip string restrict to alerts from this source ip (shorthand for --scope ip --value <IP>)
-s, --scenario string the scenario (ie. crowdsecurity/ssh-bf)
-r, --range string restrict to alerts from this range (shorthand for --scope range --value <RANGE/X>)
Expand Down
1 change: 1 addition & 0 deletions crowdsec-docs/docs/cscli/cscli_allowlists.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Manage centralized allowlists

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli allowlists add](/cscli/cscli_allowlists_add.md) - Add content to an allowlist
* [cscli allowlists check](/cscli/cscli_allowlists_check.md) - Check if a value is in an allowlist
* [cscli allowlists create](/cscli/cscli_allowlists_create.md) - Create a new allowlist
* [cscli allowlists delete](/cscli/cscli_allowlists_delete.md) - Delete an allowlist
* [cscli allowlists inspect](/cscli/cscli_allowlists_inspect.md) - Inspect an allowlist
Expand Down
6 changes: 3 additions & 3 deletions crowdsec-docs/docs/cscli/cscli_allowlists_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ cscli allowlists add my_allowlist 1.2.3.4 2.3.4.5 -e 1h -d "my comment"
### Options

```
-d, --comment string comment for the value
-e, --expiration string expiration duration
-h, --help help for add
-d, --comment string comment for the value
-e, --expiration duration expiration duration (default 0s)
-h, --help help for add
```

### Options inherited from parent commands
Expand Down
41 changes: 41 additions & 0 deletions crowdsec-docs/docs/cscli/cscli_allowlists_check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: cscli_allowlists_check
title: cscli allowlists check
---
## cscli allowlists check

Check if a value is in an allowlist

```
cscli allowlists check [value...] [flags]
```

### Examples

```
cscli allowlists check 1.2.3.4
```

### Options

```
-h, --help help for check
```

### Options inherited from parent commands

```
--color string Output color: yes, no, auto (default "auto")
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
--debug Set logging to debug
--error Set logging to error
--info Set logging to info
-o, --output string Output format: human, json, raw
--trace Set logging to trace
--warning Set logging to warning
```

### SEE ALSO

* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists

5 changes: 3 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_appsec-configs_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ cscli appsec-configs inspect [item]... [flags]
### Examples

```
# Display metadata, state, metrics and ancestor collections of appsec-configs (installed or not).
# Display metadata, state, ancestor collections of appsec-configs (installed or not).
cscli appsec-configs inspect crowdsecurity/virtual-patching

# Don't collect metrics (avoid error if crowdsec is not running).
# If the config is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
# To avoid this, use --no-metrics.
cscli appsec-configs inspect crowdsecurity/virtual-patching --no-metrics

# Display difference between a tainted item and the latest one.
Expand Down
5 changes: 3 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_appsec-rules_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ cscli appsec-rules inspect [item]... [flags]
### Examples

```
# Display metadata, state, metrics and ancestor collections of appsec-rules (installed or not).
# Display metadata, state, ancestor collections of appsec-rules (installed or not).
cscli appsec-rules inspect crowdsecurity/crs

# Don't collect metrics (avoid error if crowdsec is not running).
# If the rule is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
# To avoid this, use --no-metrics.
cscli appsec-configs inspect crowdsecurity/crs --no-metrics

# Display difference between a tainted item and the latest one.
Expand Down
5 changes: 3 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_collections_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ cscli collections inspect [item]... [flags]
### Examples

```
# Display metadata, state, metrics and dependencies of collections (installed or not).
# Display metadata, state, and dependencies of collections (installed or not).
cscli collections inspect crowdsecurity/http-cve crowdsecurity/iptables

# Don't collect metrics (avoid error if crowdsec is not running).
# If the collection is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
# To avoid this, use --no-metrics.
cscli collections inspect crowdsecurity/http-cve crowdsecurity/iptables --no-metrics

# Display difference between a tainted item and the latest one, or the reason for the taint if it's a dependency.
Expand Down
10 changes: 5 additions & 5 deletions crowdsec-docs/docs/cscli/cscli_console_enroll.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ cscli console enroll [enroll-key] [flags]

```
cscli console enroll YOUR-ENROLL-KEY
cscli console enroll --name [instance_name] YOUR-ENROLL-KEY
cscli console enroll --name [instance_name] --tags [tag_1] --tags [tag_2] YOUR-ENROLL-KEY
cscli console enroll --enable console_management YOUR-ENROLL-KEY
cscli console enroll --disable context YOUR-ENROLL-KEY
cscli console enroll --name [instance_name] YOUR-ENROLL-KEY
cscli console enroll --name [instance_name] --tags [tag_1] --tags [tag_2] YOUR-ENROLL-KEY
cscli console enroll --enable console_management YOUR-ENROLL-KEY
cscli console enroll --disable context YOUR-ENROLL-KEY

valid options are : custom,manual,tainted,context,console_management,all (see 'cscli console status' for details)
valid options are : custom,manual,tainted,context,console_management,all (see 'cscli console status' for details)
```

### Options
Expand Down
4 changes: 2 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_decisions_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ cscli decisions list --origin lists --scenario list_name

```
-a, --all Include decisions from Central API
--since string restrict to alerts newer than since (ie. 4h, 30d)
--until string restrict to alerts older than until (ie. 4h, 30d)
--since duration restrict to alerts newer than since (ie. 4h, 30d) (default 0s)
--until duration restrict to alerts older than until (ie. 4h, 30d) (default 0s)
-t, --type string restrict to this decision type (ie. ban,captcha)
--scope string restrict to this scope (ie. ip,range,session)
--origin string the value to match for the specified origin (cscli,crowdsec,console,cscli-import,lists,CAPI ...)
Expand Down
1 change: 1 addition & 0 deletions crowdsec-docs/docs/cscli/cscli_hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ cscli hub upgrade
### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli hub branch](/cscli/cscli_hub_branch.md) - Show selected hub branch
* [cscli hub list](/cscli/cscli_hub_list.md) - List all installed configurations
* [cscli hub types](/cscli/cscli_hub_types.md) - List supported item types
* [cscli hub update](/cscli/cscli_hub_update.md) - Download the latest index (catalog of available configurations)
Expand Down
40 changes: 40 additions & 0 deletions crowdsec-docs/docs/cscli/cscli_hub_branch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
id: cscli_hub_branch
title: cscli hub branch
---
## cscli hub branch

Show selected hub branch

### Synopsis

Display the hub branch to be used, depending on configuration and crowdsec version

```
cscli hub branch [flags]
```

### Options

```
-a, --all List all available items, including those not installed
-h, --help help for branch
```

### Options inherited from parent commands

```
--color string Output color: yes, no, auto (default "auto")
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
--debug Set logging to debug
--error Set logging to error
--info Set logging to info
-o, --output string Output format: human, json, raw
--trace Set logging to trace
--warning Set logging to warning
```

### SEE ALSO

* [cscli hub](/cscli/cscli_hub.md) - Manage hub index

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_hubtest_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ cscli hubtest run [flags]
--clean Clean runtime environment if test fail
-h, --help help for run
--host string Address to expose AppSec for hubtest (default "127.0.0.1:4241")
--max-jobs uint Max number of concurrent tests (does not apply to appsec) (default 8)
--max-jobs uint Max number of concurrent tests (does not apply to appsec) (default 16)
--no-clean Don't clean runtime environment if test succeed
--report-success Report successful tests too (implied with json output)
--target string Target for AppSec Test (default "http://127.0.0.1:7822/")
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ cscli metrics [flags]
### Examples

```
# Show all Metrics, skip empty tables (same as "cecli metrics show")
# Show all Metrics, skip empty tables (same as "cscli metrics show")
cscli metrics

# Show only some metrics, connect to a different url
Expand Down
5 changes: 3 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_parsers_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ cscli parsers inspect [item]... [flags]
### Examples

```
# Display metadata, state, metrics and ancestor collections of parsers (installed or not).
# Display metadata, state and ancestor collections of parsers (installed or not).
cscli parsers inspect crowdsecurity/httpd-logs crowdsecurity/sshd-logs

# Don't collect metrics (avoid error if crowdsec is not running).
# If the parser is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
# To avoid this, use --no-metrics.
cscli parsers inspect crowdsecurity/httpd-logs --no-metrics

# Display difference between a tainted item and the latest one.
Expand Down
5 changes: 3 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_scenarios_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ cscli scenarios inspect [item]... [flags]
### Examples

```
# Display metadata, state, metrics and ancestor collections of scenarios (installed or not).
# Display metadata, state and ancestor collections of scenarios (installed or not).
cscli scenarios inspect crowdsecurity/ssh-bf crowdsecurity/http-probing

# Don't collect metrics (avoid error if crowdsec is not running).
# If the scenario is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
# To avoid this, use --no-metrics.
cscli scenarios inspect crowdsecurity/ssh-bf --no-metrics

# Display difference between a tainted item and the latest one.
Expand Down
9 changes: 8 additions & 1 deletion crowdsec-docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,7 @@ const sidebarsConfig: SidebarConfig = {
"cscli/cscli_allowlists_add",
"cscli/cscli_allowlists_create",
"cscli/cscli_allowlists_delete",
"cscli/cscli_allowlists_check",
"cscli/cscli_allowlists_inspect",
"cscli/cscli_allowlists_list",
"cscli/cscli_allowlists_remove",
Expand Down Expand Up @@ -470,7 +471,13 @@ const sidebarsConfig: SidebarConfig = {
type: "doc",
id: "cscli/cscli_hub",
},
items: ["cscli/cscli_hub_list", "cscli/cscli_hub_update", "cscli/cscli_hub_upgrade", "cscli/cscli_hub_types"],
items: [
"cscli/cscli_hub_list",
"cscli/cscli_hub_update",
"cscli/cscli_hub_upgrade",
"cscli/cscli_hub_types",
"cscli/cscli_hub_branch",
],
},
{
type: "doc",
Expand Down