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

fix doc for output plugins (#167)

Browse source
This commit is contained in:
Thibault "bui" Koechlin 2020-07-30 17:12:29 +02:00 committed by GitHub
parent 8dc8d2c81d
commit 895f336900
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/references/output.md
View file

@ -121,12 +121,12 @@ config:
# Plugins
Plugins configuration file are stored in `{{blockers.configpath}}`. {{crowdsec.name}} will scan this folder to load all the plugins. Each configuration file should provide the path to the plugin binary. By default they are stored in `{{blockers.binpath}}`.
Plugins configuration file are stored in `{{plugins.configpath}}`. {{crowdsec.Name}} will scan this folder to load all the plugins. Each configuration file should provide the path to the plugin binary. By default they are stored in `{{plugins.binpath}}`.
!!! info
If you want crowdsec to not load a plugin, `mv` or `rm` its configuration file in `{{blockers.configpath}}`
If you want crowdsec to not load a plugin, `mv` or `rm` its configuration file in `{{plugins.configpath}}`
Here is a sample of a plugin configuration file stored in `{{blockers.configpath}}`:
Here is a sample of a plugin configuration file stored in `{{plugins.configpath}}`:
```yaml
name: <plugin_name>
path: <path_to_plugin_binary> #

15
mkdocs.yml
View file

@ -140,12 +140,14 @@ extra:
acquis_path: "/etc/crowdsec/config/acquis.yaml"
blockers:
name: blockers
url: "https://hub.crowdsec.net/"
binpath: "/usr/local/lib/crowdsec/plugins/"
configpath: "/etc/crowdsec/"
backend:
Name: Blockers
url: "https://hub.crowdsec.net/browse/#blockers"
htmlname: "[blockers](/blockers/)"
Htmlname: "[blockers](/blockers/)"
plugins:
name: backend plugins
configpath: "/etc/crowdsec/plugins/backend/"
binpath: "/usr/local/lib/crowdsec/plugins/"
metabase:
name: metabase
url: https://github.com/crowdsecurity/crowdsec
@ -229,11 +231,6 @@ extra:
Name: Signal
htmlname: "[signal](/getting_started/glossary/#overflow-or-signaloccurence)"
Htmlname: "[Signal](/getting_started/glossary/#overflow-or-signaloccurence)"
blockers:
name: blockers
Name: Blockers
htmlname: "[blockers](/blockers/)"
Htmlname: "[blockers](/blockers/)"
#scenario stuff
leakspeed:
name: leakspeed