forked from crowdsecurity/crowdsec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
262 lines (261 loc) · 9.89 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
site_name: Crowdsec
nav:
- Home: index.md
- Getting Started:
- Installation : getting_started/installation.md
- Crowdsec Tour: getting_started/crowdsec-tour.md
- Concepts & Glossary : getting_started/concepts.md
- FAQ: getting_started/FAQ.md
- Guide:
- Overview: guide/crowdsec/overview.md
- Acquisition: guide/crowdsec/acquisition.md
- Parsers: guide/crowdsec/parsers.md
- Enrichers: guide/crowdsec/enrichers.md
- Scenarios: guide/crowdsec/scenarios.md
- Cscli: guide/cscli.md
- Simulation Mode: guide/crowdsec/simulation.md
- Cheat Sheets:
- Ban Management: cheat_sheets/ban-mgmt.md
- Configuration Management: cheat_sheets/config-mgmt.md
- Hub's taxonomy: https://hub.crowdsec.net/fields
- Debugging Parsers & Scenarios: cheat_sheets/debugging_configs.md
- Observability:
- Overview: observability/overview.md
- Logs: observability/logs.md
- Metrics:
- Prometheus: observability/prometheus.md
- Command line: observability/command_line.md
- Dashboard: observability/dashboard.md
- References:
- Parsers format: references/parsers.md
- Scenarios format: references/scenarios.md
- Outputs format: references/output.md
- Write Configurations:
- Requirements: write_configurations/requirements.md
- Acquisition: write_configurations/acquisition.md
- Parsers: write_configurations/parsers.md
- Scenarios: write_configurations/scenarios.md
- Whitelists: write_configurations/whitelist.md
- Expressions: write_configurations/expressions.md
- Bouncers:
- Overview : bouncers/index.md
- Nginx:
- Installation : "https://github.com/crowdsecurity/cs-nginx-blocker#installation"
- Configuration : "https://github.com/crowdsecurity/cs-nginx-blocker#configuration"
- Netfilter:
- Installation : "https://github.com/crowdsecurity/cs-netfilter-blocker#installation"
- Configuration : "https://github.com/crowdsecurity/cs-netfilter-blocker#configuration"
- Custom:
- Installation: "https://github.com/crowdsecurity/cs-custom-blocker#installation"
- 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:
- General: contributing/
- Writing Output Plugins: references/plugins_api.md
- Cscli commands:
- API: cscli/cscli_api.md
- Backup: cscli/cscli_backup.md
- Bans: cscli/cscli_ban.md
- Metrics: cscli/cscli_metrics.md
- Update: cscli/cscli_update.md
- Install configurations: cscli/cscli_install.md
- Remove configurations: cscli/cscli_remove.md
- Upgrade configurations: cscli/cscli_upgrade.md
- List configurations: cscli/cscli_list.md
- Inspect configurations: cscli/cscli_inspect.md
- Manage simulation: cscli/cscli_simulation.md
- Dashboard: cscli/cscli_dashboard.md
- About: about.md
markdown_extensions:
- codehilite:
guess_lang: false
- toc:
permalink: true
- admonition
theme:
name: material
logo: assets/images/crowdsec2.png
favicon: assets/images/crowdsec2.png
palette:
primary: "#3d85c6"
language: en
font:
text: Montserrat
highlightjs: true
hljs_languages:
- yaml
repo_url: https://github.com/crowdsecurity/crowdsec
repo_name: GitHub
plugins:
- search
- macros
google_analytics:
- UA-164365852-3
- auto
extra:
doc:
new_issue: "[new documentation issue](https://github.com/crowdsecurity/crowdsec/issues/new)"
discourse: "[CrowdSecurity discourse](http://discourse.crowdsec.net)"
community: "[community](http://discourse.crowdsec.net)"
hub:
name: Crowdsec Hub
htmlname: "[Crowdsec Hub](https://hub.crowdsec.net/)"
url: "https://hub.crowdsec.net/"
plugins_url: "https://hub.crowdsec.net/browse/#bouncers"
scenarios_url: "https://hub.crowdsec.net/browse/#configurations"
parsers_url: "https://hub.crowdsec.net/browse/#configurations"
collections_url: "https://hub.crowdsec.net/browse/#collections"
crowdsec:
name: Crowdsec
Name: Crowdsec
bin: crowdsec-agent
path: /usr/bin/crowdsec-agent
url: https://github.com/crowdsecurity/crowdsec
bugreport: "https://github.com/crowdsecurity/crowdsec/issues"
main_log: "/var/log/crowdsec.log"
download_url: https://github.com/crowdsecurity/crowdsec/releases/latest
cli:
name: cscli
Name: Cscli
bin: cscli
path: /usr/bin/cscli
main_doc: /cscli/cscli/
url: "https://github.com/crowdsecurity/crowdsec"
bugreport: "https://github.com/crowdsecurity/crowdsec/issues"
api_doc: /cscli/cscli_api/
ban_doc: /cscli/cscli_ban/
metrics_doc: /cscli/cscli_metrics/
remove_doc: /cscli/cscli_remove/
install_doc: /cscli/cscli_install/
list_doc: /cscli/cscli_list/
update_doc: /cscli/cscli_update/
upgrade_doc: /cscli/cscli_upgrade/
backup_doc: /cscli/cscli_backup/
simulation_doc: /cscli/cscli_simulation/
config:
cli_dir: /etc/crowdsec/cscli/
crowdsec_dir: "/etc/crowdsec/config/"
acquis_path: "/etc/crowdsec/config/acquis.yaml"
bouncers:
name: bouncers
Name: Bouncers
url: "https://hub.crowdsec.net/browse/#bouncers"
htmlname: "[bouncers](/bouncers/)"
Htmlname: "[Bouncers](/bouncers/)"
plugins:
name: backend plugins
configpath: "/etc/crowdsec/plugins/backend/"
binpath: "/usr/local/lib/crowdsec/plugins/"
metabase:
name: metabase
url: https://github.com/crowdsecurity/crowdsec
wizard:
name: wizard
url: "https://github.com/crowdsecurity/crowdsec"
bin: "./wizard.sh"
bugreport: "https://github.com/crowdsecurity/crowdsec/issues"
ref:
parser: "[parser](/references/parsers/)"
Parser: "[Parser](/references/parsers/)"
scenario: "[scenarios](/references/scenarios/)"
Scenario: "[Scenarios](/references/scenarios/)"
acquis: "[acquisition](/guide/crowdsec/acquisition/)"
Acquis: "[Acquisition](/guide/crowdsec/acquisition/)"
output: "[output](/references/output/)"
Output: "[Output](/references/output/)"
# All the technical terms
event:
name: event
Name: Event
htmlname: "[event](/getting_started/concepts/#event)"
Htmlname: "[Event](/getting_started/concepts/#event)"
expr:
name: expr
Name: Expr
htmlname: "[expr](/write_configurations/expressions/)"
Htmlname: "[Expr](/write_configurations/expressions/)"
filter:
name: filter
Name: Filter
htmlname: "[filter](/references/parsers/#filter)"
Htmlname: "[Filter](/references/parsers/#filter)"
onsuccess:
name: onsuccess
Name: Onsuccess
htmlname: "[onsuccess](/references/parsers/#onsuccess)"
Htmlname: "[Onsuccess](/references/parsers/#onsuccess)"
statics:
name: statics
Name: Statics
htmlname: "[statics](/references/parsers/#statics)"
Htmlname: "[Statics](/references/parsers/#statics)"
parsers:
name: parsers
Name: Parsers
htmlname: "[parsers](/getting_started/concepts/#parser)"
Htmlname: "[Parsers](/getting_started/concepts/#parser)"
scenarios:
name: scenarios
Name: Scenarios
htmlname: "[scenarios](/getting_started/concepts/#scenario)"
Htmlname: "[Scenarios](/getting_started/concepts/#scenario)"
collections:
name: collections
Name: Collections
htmlname: "[collections](/getting_started/concepts/#collections)"
Htmlname: "[Collections](/getting_started/concepts/#collections)"
timeMachine:
name: timeMachine
Name: TimeMachine
htmlname: "[timeMachine](/getting_started/concepts/#timemachine)"
Htmlname: "[TimeMachine](/getting_started/concepts/#timemachine)"
overflow:
name: overflow
Name: Overflow
htmlname: "[overflow](/getting_started/concepts/#overflow-or-signaloccurence)"
Htmlname: "[Overflow](/getting_started/concepts/#overflow-or-signaloccurence)"
whitelists:
name: whitelists
Name: Whitelists
htmlname: "[whitelists](/write_configurations/whitelist/)"
Htmlname: "[Whitelists](/write_configurations/whitelist/)"
signal:
name: alert
Name: Alert
htmlname: "[alert](/getting_started/concepts/#overflow-or-signaloccurence)"
Htmlname: "[Alert](/getting_started/concepts/#overflow-or-signaloccurence)"
#scenario stuff
stage:
name: stage
Name: Stage
htmlname: "[stage](/getting_started/concepts/#stages)"
Htmlname: "[Stage](/getting_started/concepts/#stages)"
leakspeed:
name: leakspeed
Name: Leakspeed
htmlname: "[leakspeed](/references/scenarios/#leakspeed)"
Htmlname: "[Leakspeed](/references/scenarios/#leakspeed)"
capacity:
name: capacity
Name: Capacity
htmlname: "[capacity](/references/scenarios/#capacity)"
Htmlname: "[Capacity](/references/scenarios/#capacity)"
duration:
name: duration
Name: Duration
htmlname: "[duration](/references/scenarios/#duration)"
Htmlname: "[Duration](/references/scenarios/#duration)"
prometheus:
name: prometheus
htmlname: "[prometheus](https://github.com/prometheus/client_golang)"
api:
name: API
htmlname: "[API](TBD)"
topX:
name: topX
htmlname: "[topX](TBD)"