Skip to content

Commit bc861c3

Browse files
committed
update cscli docs for 1.7.0
1 parent 511f92a commit bc861c3

15 files changed

+405
-255
lines changed

crowdsec-docs/docs/cscli/cscli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cscli allows you to manage crowdsec
99
### Synopsis
1010

1111
cscli is the main command to interact with your crowdsec service, scenarios & db.
12-
It is meant to allow you to manage bans, parsers/scenarios/etc, api and generally manage you crowdsec setup.
12+
It is meant to allow you to manage bans, parsers/scenarios/etc, api and generally manage your crowdsec setup.
1313

1414
### Options
1515

@@ -38,7 +38,6 @@ It is meant to allow you to manage bans, parsers/scenarios/etc, api and generall
3838
* [cscli config](/cscli/cscli_config.md) - Allows to view current config
3939
* [cscli console](/cscli/cscli_console.md) - Manage interaction with Crowdsec console (https://app.crowdsec.net)
4040
* [cscli contexts](/cscli/cscli_contexts.md) - Manage hub contexts
41-
* [cscli dashboard](/cscli/cscli_dashboard.md) - Manage your metabase dashboard container [requires local API]
4241
* [cscli decisions](/cscli/cscli_decisions.md) - Manage decisions
4342
* [cscli explain](/cscli/cscli_explain.md) - Explain log pipeline
4443
* [cscli hub](/cscli/cscli_hub.md) - Manage hub index
@@ -51,6 +50,7 @@ It is meant to allow you to manage bans, parsers/scenarios/etc, api and generall
5150
* [cscli parsers](/cscli/cscli_parsers.md) - Manage hub parsers
5251
* [cscli postoverflows](/cscli/cscli_postoverflows.md) - Manage hub postoverflows
5352
* [cscli scenarios](/cscli/cscli_scenarios.md) - Manage hub scenarios
53+
* [cscli setup](/cscli/cscli_setup.md) - Tools to configure crowdsec
5454
* [cscli simulation](/cscli/cscli_simulation.md) - Manage simulation status of scenarios
5555
* [cscli support](/cscli/cscli_support.md) - Provide commands to help during support
5656
* [cscli version](/cscli/cscli_version.md) - Display version

crowdsec-docs/docs/cscli/cscli_dashboard.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

crowdsec-docs/docs/cscli/cscli_dashboard_setup.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

crowdsec-docs/docs/cscli/cscli_dashboard_show-password.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

crowdsec-docs/docs/cscli/cscli_dashboard_start.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

crowdsec-docs/docs/cscli/cscli_dashboard_stop.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

crowdsec-docs/docs/cscli/cscli_hub.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ Hub management
1313
List/update parsers/scenarios/postoverflows/collections from [Crowdsec Hub](https://hub.crowdsec.net).
1414
The Hub is managed by cscli, to get the latest hub files from [Crowdsec Hub](https://hub.crowdsec.net), you need to update.
1515

16+
```
17+
cscli hub [action] [flags]
18+
```
19+
1620
### Examples
1721

1822
```
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
id: cscli_setup
3+
title: cscli setup
4+
---
5+
## cscli setup
6+
7+
Tools to configure crowdsec
8+
9+
### Synopsis
10+
11+
Manage service detection and hub/acquisition configuration
12+
13+
```
14+
cscli setup [flags]
15+
```
16+
17+
### Examples
18+
19+
```
20+
# Call one of detect, install-hub, etc.
21+
cscli setup [command]
22+
# With no explicit command, will run as "cscli setup interactive"
23+
# and pass through any flags.
24+
25+
```
26+
27+
### Options
28+
29+
```
30+
--detect-config string path to service detection configuration, will use $CROWDSEC_SETUP_DETECT_CONFIG if defined (default "/var/lib/crowdsec/data/detect.yaml")
31+
--ignore strings ignore a detected service (can be repeated)
32+
--force strings force the detection of a service (can be repeated)
33+
--skip-systemd don't use systemd, even if available
34+
--acquis-dir string Directory for the acquisition configuration
35+
--dry-run simulate the installation without making any changes
36+
-h, --help help for setup
37+
```
38+
39+
### Options inherited from parent commands
40+
41+
```
42+
--color string Output color: yes, no, auto (default "auto")
43+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
44+
--debug Set logging to debug
45+
--error Set logging to error
46+
--info Set logging to info
47+
-o, --output string Output format: human, json, raw
48+
--trace Set logging to trace
49+
--warning Set logging to warning
50+
```
51+
52+
### SEE ALSO
53+
54+
* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
55+
* [cscli setup detect](/cscli/cscli_setup_detect.md) - Detect installed services and generate a setup file
56+
* [cscli setup install-acquisition](/cscli/cscli_setup_install-acquisition.md) - Generate acquisition configuration from a setup file
57+
* [cscli setup install-hub](/cscli/cscli_setup_install-hub.md) - Install recommended hub items from a setup file
58+
* [cscli setup interactive](/cscli/cscli_setup_interactive.md) - Interactive setup
59+
* [cscli setup unattended](/cscli/cscli_setup_unattended.md) - Unattended setup
60+
* [cscli setup validate](/cscli/cscli_setup_validate.md) - Validate a setup file
61+
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
id: cscli_setup_detect
3+
title: cscli setup detect
4+
---
5+
## cscli setup detect
6+
7+
Detect installed services and generate a setup file
8+
9+
### Synopsis
10+
11+
Detects the services installed on the machine and builds a specification
12+
to be used with the "setup install-*" commands.
13+
14+
```
15+
cscli setup detect [flags]
16+
```
17+
18+
### Examples
19+
20+
```
21+
# detect services and print the setup plan
22+
cscli setup detect
23+
24+
# force yaml instead of json (easier to edit)
25+
cscli setup detect --yaml
26+
27+
# detect and skip certain services
28+
cscli setup detect --ignore whitelists
29+
30+
```
31+
32+
### Options
33+
34+
```
35+
--detect-config string path to service detection configuration, will use $CROWDSEC_SETUP_DETECT_CONFIG if defined (default "/var/lib/crowdsec/data/detect.yaml")
36+
--ignore strings ignore a detected service (can be repeated)
37+
--force strings force the detection of a service (can be repeated)
38+
--skip-systemd don't use systemd, even if available
39+
--yaml output yaml, not json
40+
--list-supported-services do not detect; only print supported services
41+
-h, --help help for detect
42+
```
43+
44+
### Options inherited from parent commands
45+
46+
```
47+
--color string Output color: yes, no, auto (default "auto")
48+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
49+
--debug Set logging to debug
50+
--error Set logging to error
51+
--info Set logging to info
52+
-o, --output string Output format: human, json, raw
53+
--trace Set logging to trace
54+
--warning Set logging to warning
55+
```
56+
57+
### SEE ALSO
58+
59+
* [cscli setup](/cscli/cscli_setup.md) - Tools to configure crowdsec
60+

0 commit comments

Comments
 (0)