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
1 change: 1 addition & 0 deletions crowdsec-docs/docs/cscli/cscli_bouncers.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Note: This command requires database direct access, so is intended to be run on
* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli bouncers add](/cscli/cscli_bouncers_add.md) - add a single bouncer to the database
* [cscli bouncers delete](/cscli/cscli_bouncers_delete.md) - delete bouncer(s) from the database
* [cscli bouncers inspect](/cscli/cscli_bouncers_inspect.md) - inspect a bouncer by name
* [cscli bouncers list](/cscli/cscli_bouncers_list.md) - list all bouncers within the database
* [cscli bouncers prune](/cscli/cscli_bouncers_prune.md) - prune multiple bouncers from the database

9 changes: 8 additions & 1 deletion crowdsec-docs/docs/cscli/cscli_bouncers_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,17 @@ delete bouncer(s) from the database
cscli bouncers delete MyBouncerName [flags]
```

### Examples

```
cscli bouncers delete "bouncer1" "bouncer2"
```

### Options

```
-h, --help help for delete
-h, --help help for delete
--ignore-missing don't print errors if one or more bouncers don't exist
```

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

inspect a bouncer by name

```
cscli bouncers inspect [bouncer_name] [flags]
```

### Examples

```
cscli bouncers inspect "bouncer1"
```

### Options

```
-h, --help help for inspect
```

### 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 bouncers](/cscli/cscli_bouncers.md) - Manage bouncers [requires local API]

3 changes: 2 additions & 1 deletion crowdsec-docs/docs/cscli/cscli_hub_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ cscli hub update [flags]
### Options

```
-h, --help help for update
-h, --help help for update
--with-content Download index with embedded item content
```

### Options inherited from parent commands
Expand Down
4 changes: 0 additions & 4 deletions crowdsec-docs/docs/cscli/cscli_lapi_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ title: cscli lapi context

Manage context to send with alerts

```
cscli lapi context [command] [flags]
```

### Options

```
Expand Down
1 change: 1 addition & 0 deletions crowdsec-docs/docs/cscli/cscli_lapi_register.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ cscli lapi register [flags]
-f, --file string output file destination
-h, --help help for register
--machine string Name of the machine to register with
--token string Auto registration token to use
-u, --url string URL of the API (ie. http://127.0.0.1)
```

Expand Down
1 change: 1 addition & 0 deletions crowdsec-docs/docs/cscli/cscli_machines.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ cscli machines [action]
* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli machines add](/cscli/cscli_machines_add.md) - add a single machine to the database
* [cscli machines delete](/cscli/cscli_machines_delete.md) - delete machine(s) by name
* [cscli machines inspect](/cscli/cscli_machines_inspect.md) - inspect a machine by name
* [cscli machines list](/cscli/cscli_machines_list.md) - list all machines in the database
* [cscli machines prune](/cscli/cscli_machines_prune.md) - prune multiple machines from the database
* [cscli machines validate](/cscli/cscli_machines_validate.md) - validate a machine to access the local API
Expand Down
3 changes: 2 additions & 1 deletion crowdsec-docs/docs/cscli/cscli_machines_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ cscli machines delete "machine1" "machine2"
### Options

```
-h, --help help for delete
-h, --help help for delete
--ignore-missing don't print errors if one or more machines don't exist
```

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

inspect a machine by name

```
cscli machines inspect [machine_name] [flags]
```

### Examples

```
cscli machines inspect "machine1"
```

### Options

```
-h, --help help for inspect
-H, --hub show hub state
```

### 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 machines](/cscli/cscli_machines.md) - Manage local API machines [requires local API]

4 changes: 2 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ To list/inspect/test notification template
### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli notifications inspect](/cscli/cscli_notifications_inspect.md) - Inspect active notifications plugin configuration
* [cscli notifications list](/cscli/cscli_notifications_list.md) - list active notifications plugins
* [cscli notifications inspect](/cscli/cscli_notifications_inspect.md) - Inspect notifications plugin
* [cscli notifications list](/cscli/cscli_notifications_list.md) - list notifications plugins
* [cscli notifications reinject](/cscli/cscli_notifications_reinject.md) - reinject an alert into profiles to trigger notifications
* [cscli notifications test](/cscli/cscli_notifications_test.md) - send a generic test alert to notification plugin

4 changes: 2 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_notifications_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: cscli notifications inspect
---
## cscli notifications inspect

Inspect active notifications plugin configuration
Inspect notifications plugin

### Synopsis

Inspect active notifications plugin and show configuration
Inspect notifications plugin and show configuration

```
cscli notifications inspect [flags]
Expand Down
4 changes: 2 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_notifications_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: cscli notifications list
---
## cscli notifications list

list active notifications plugins
list notifications plugins

### Synopsis

list active notifications plugins
list notifications plugins and their status (active or not)

```
cscli notifications list [flags]
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_notifications_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ send a generic test alert to notification plugin

### Synopsis

send a generic test alert to a notification plugin to test configuration even if is not active
send a generic test alert to a notification plugin even if it is not active in profiles

```
cscli notifications test [plugin name] [flags]
Expand Down
17 changes: 7 additions & 10 deletions crowdsec-docs/docs/cscli/cscli_support_dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,17 @@ Dump all your configuration to a zip file for easier support

### Synopsis

Dump the following informations:
Dump the following information:
- Crowdsec version
- OS version
- Installed collections list
- Installed parsers list
- Installed scenarios list
- Installed postoverflows list
- Installed context list
- Bouncers list
- Machines list
- CAPI status
- LAPI status
- Enabled feature flags
- Latest Crowdsec logs (log processor, LAPI, remediation components)
- Installed collections, parsers, scenarios...
- Bouncers and machines list
- CAPI/LAPI status
- Crowdsec config (sensitive information like username and password are redacted)
- Crowdsec metrics
- Stack trace in case of process crash

```
cscli support dump [flags]
Expand Down
2 changes: 2 additions & 0 deletions crowdsec-docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,7 @@
items: [
"cscli/cscli_bouncers_add",
"cscli/cscli_bouncers_delete",
"cscli/cscli_bouncers_inspect",
"cscli/cscli_bouncers_list",
"cscli/cscli_bouncers_prune",
],
Expand Down Expand Up @@ -563,6 +564,7 @@
items: [
"cscli/cscli_machines_add",
"cscli/cscli_machines_delete",
"cscli/cscli_machines_inspect",
"cscli/cscli_machines_list",
"cscli/cscli_machines_prune",
"cscli/cscli_machines_validate",
Expand Down