From 895f33690007bcb04d9ed03bbd4c7b72f7a2ae85 Mon Sep 17 00:00:00 2001 From: "Thibault \"bui\" Koechlin" Date: Thu, 30 Jul 2020 17:12:29 +0200 Subject: [PATCH] fix doc for output plugins (#167) --- docs/references/output.md | 6 +++--- mkdocs.yml | 15 ++++++--------- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/references/output.md b/docs/references/output.md index b5d531459..8831f785f 100644 --- a/docs/references/output.md +++ b/docs/references/output.md @@ -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: path: # diff --git a/mkdocs.yml b/mkdocs.yml index 36a8b02f6..8c9ef357e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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