0ct0pu5/crowdsec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

make doc more explicitit on initial collection install

Browse source
This commit is contained in:
Thibault bui Koechlin 2020-07-20 16:30:03 +02:00
parent c4ab77f0a3
commit 95400086ea
3 changed files with 18 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/getting_started/crowdsec-tour.md
View file

@ -2,9 +2,17 @@
## Finding configurations ## Finding configurations
As stated, {{crowdsec.name}} efficiency is dictated by installed parsers and scenarios. {{crowdsec.Name}} efficiency is dictated by installed parsers and scenarios, so [take a look at the {{hub.name}}]({{hub.url}}) to find the appropriated ones !
[Please take a look at the {{hub.name}}]({{hub.url}}) to find the appropriated ones ! If you didn't perform the setup with the wizard, or if you are reading logs from other machines, you will have to pick the right {{collections.htmlname}}. This will ensure that {{crowdsec.name}} can parse the logs and has the corresponding scenarios.
For example, if you're processing [nginx](http://nginx.org) logs, you might want to install the [nginx collection](https://hub.crowdsec.net/author/crowdsecurity/collections/nginx).
A collection can be installed by typing `cscli install collection crowdsecurity/nginx`, and provides all the necessary parsers and scenarios to handle said log source. `systemctl reload crowdsec` to ensure the new scenarios are loaded.
In the same spirit, the [crowdsecurity/sshd](https://hub.crowdsec.net/author/crowdsecurity/collections/sshd)'s collection will fit most sshd setups !
While {{crowdsec.name}} is running, a quick look at [`cscli metrics`](/observability/metrics/) should help you ensure that your log sources are correctly parsed.
## List installed configurations ## List installed configurations

4
docs/index.md
View file

@ -17,9 +17,9 @@ Besides detecting and stopping attacks in real time based on your logs, it allow
## Components ## Components
{{crowdsec.name}} ecosystem is based on the following tools : {{crowdsec.name}} ecosystem is based on the following components :
- {{crowdsec.name}} is the "service" that runs in the background, processes logs and keeps track of attacks - {{crowdsec.name}} is the lightweight service that processes logs and keeps track of attacks.
- [{{cli.name}}]({{cli.main_doc}}) is the command line interface for humans, it allows you to view, add, or remove bans as well as to install, find ,or update scenarios and parsers - [{{cli.name}}]({{cli.main_doc}}) is the command line interface for humans, it allows you to view, add, or remove bans as well as to install, find ,or update scenarios and parsers
- [{{blockers.name}}]({{hub.plugins_url}}) are the components that block malevolent traffic, and can be deployed anywhere in your stack - [{{blockers.name}}]({{hub.plugins_url}}) are the components that block malevolent traffic, and can be deployed anywhere in your stack

12
mkdocs.yml
View file

@ -39,18 +39,18 @@ nav:
- Nginx: - Nginx:
- Installation : "https://github.com/crowdsecurity/cs-nginx-blocker#installation" - Installation : "https://github.com/crowdsecurity/cs-nginx-blocker#installation"
- Configuration : "https://github.com/crowdsecurity/cs-nginx-blocker#configuration" - Configuration : "https://github.com/crowdsecurity/cs-nginx-blocker#configuration"
- Wordpress:
- Installation : "https://github.com/crowdsecurity/cs-wordpress-plugin/#installation"
- Configuration : "https://github.com/crowdsecurity/cs-wordpress-plugin/#configuration"
- Netfilter: - Netfilter:
- Installation : "https://github.com/crowdsecurity/cs-netfilter-blocker#installation" - Installation : "https://github.com/crowdsecurity/cs-netfilter-blocker#installation"
- Configuration : "https://github.com/crowdsecurity/cs-netfilter-blocker#configuration" - Configuration : "https://github.com/crowdsecurity/cs-netfilter-blocker#configuration"
- Cloudflare:
- Installation: "https://github.com/crowdsecurity/cs-cloudflare-blocker#installation"
- Configuration: "https://github.com/crowdsecurity/cs-cloudflare-blocker#configuration"
- Custom: - Custom:
- Installation: "https://github.com/crowdsecurity/cs-custom-blocker#installation" - Installation: "https://github.com/crowdsecurity/cs-custom-blocker#installation"
- Configuration: "https://github.com/crowdsecurity/cs-custom-blocker#configuration" - Configuration: "https://github.com/crowdsecurity/cs-custom-blocker#configuration"
- Cloudflare:
- Installation: "https://github.com/crowdsecurity/cs-cloudflare-blocker#installation"
- Configuration: "https://github.com/crowdsecurity/cs-cloudflare-blocker#configuration"
- Wordpress:
- Installation : "https://github.com/crowdsecurity/cs-wordpress-plugin/#installation"
- Configuration : "https://github.com/crowdsecurity/cs-wordpress-plugin/#configuration"
- Contributing: contributing/ - Contributing: contributing/
- Cscli commands: - Cscli commands:
- API: cscli/cscli_api.md - API: cscli/cscli_api.md