bitbucket.org/Aishee/synsec@v0.0.0-20210414005726-236fc01a153d/mkdocs.yml (about) 1 site_name: Synsec 2 nav: 3 - Home: index.md 4 - Synsec v0: "!include ./docs/v0.3.X/mkdocs.yml" 5 - Synsec v1 : "!include ./docs/v1.X/mkdocs.yml" 6 - API Swagger : https://breakteam.github.io/api_doc/index.html?urls.primaryName=LAPI" target="_blank 7 - Hub : https://hub.synsec.net/" target="_blank 8 - Releases : https://bitbucket.org/Aishee/synsec/releases" target="_blank 9 - Contributing: 10 - Guide: contributing.md 11 - FAQ: 12 - Questions: faq.md 13 14 15 markdown_extensions: 16 - codehilite: 17 guess_lang: false 18 - toc: 19 permalink: true 20 - admonition 21 theme: 22 name: material 23 logo: assets/images/synsec2.png 24 favicon: assets/images/synsec2.png 25 features: 26 - navigation.tabs 27 - navigation.expand 28 - navigation.instant 29 - navigation.section 30 palette: 31 primary: "#3d85c6" 32 language: en 33 font: 34 text: Montserrat 35 highlightjs: true 36 hljs_languages: 37 - yaml 38 repo_url: https://bitbucket.org/Aishee/synsec 39 repo_name: GitHub 40 plugins: 41 - search 42 - macros 43 - monorepo 44 45 extra: 46 swagger_url: "https://raw.githubusercontent.com/breakteam/synsec/master/pkg/models/localapi_swagger.yaml" 47 v0X: 48 doc: 49 new_issue: "[new documentation issue](https://bitbucket.org/Aishee/synsec/issues/new)" 50 discourse: "[BreakTeam discourse](http://discourse.synsec.net)" 51 gitter: "[Synsec gitter](http://discourse.synsec.net)" 52 hub: 53 name: Synsec Hub 54 htmlname: "[Synsec Hub](https://hub.synsec.net/)" 55 url: "https://hub.synsec.net/" 56 plugins_url: "https://hub.synsec.net/browse/#bouncers" 57 scenarios_url: "https://hub.synsec.net/browse/#configurations" 58 parsers_url: "https://hub.synsec.net/browse/#configurations" 59 collections_url: "https://hub.synsec.net/browse/#collections" 60 synsec: 61 name: Synsec 62 Name: Synsec 63 bin: synsec-agent 64 path: /usr/bin/synsec-agent 65 url: https://bitbucket.org/Aishee/synsec 66 bugreport: "https://bitbucket.org/Aishee/synsec/issues" 67 main_log: "/var/log/synsec.log" 68 download_url: https://bitbucket.org/Aishee/synsec/releases 69 cli: 70 name: ccscli 71 Name: ccscli 72 main_doc: /Synsec/v0/ccscli/ccscli/ 73 url: "https://bitbucket.org/Aishee/synsec" 74 bugreport: "https://bitbucket.org/Aishee/synsec/issues" 75 # alerts_doc: /Synsec/v1/ccscli/ccscli_alerts/ 76 # decisions_doc: /Synsec/v1/ccscli/ccscli_decisions/ 77 # collections_doc: /Synsec/v1/ccscli/ccscli_collections/ 78 # parsers_doc: /Synsec/v1/ccscli/ccscli_parsers/ 79 # scenarios_doc: /Synsec/v1/ccscli/ccscli_scenarios/ 80 81 # api_doc: /Synsec/v0/ccscli/ccscli_api/ 82 # ban_doc: /Synsec/v0/ccscli/ccscli_ban/ 83 # metrics_doc: /Synsec/v0/ccscli/ccscli_metrics/ 84 # remove_doc: /Synsec/v0/ccscli/ccscli_remove/ 85 # install_doc: /Synsec/v0/ccscli/ccscli_install/ 86 # list_doc: /Synsec/v0/ccscli/ccscli_list/ 87 # update_doc: /Synsec/v0/ccscli/ccscli_update/ 88 # upgrade_doc: /Synsec/v0/ccscli/ccscli_upgrade/ 89 # backup_doc: /Synsec/v0/ccscli/ccscli_backup/ 90 # simulation_doc: /Synsec/v0/ccscli/ccscli_simulation/ 91 config: 92 cli_dir: /etc/synsec/ccscli/ 93 synsec_dir: "/etc/synsec/config/" 94 acquis_path: "/etc/synsec/config/acquis.yaml" 95 bouncers: 96 name: bouncers 97 Name: bouncers 98 url: "https://hub.synsec.net/browse/#bouncers" 99 htmlname: "[bouncers](/Synsec/v0/bouncers/)" 100 Htmlname: "[Bouncers](/Synsec/v0/bouncers/)" 101 plugins: 102 name: backend plugins 103 configpath: "/etc/synsec/plugins/backend/" 104 binpath: "/usr/local/lib/synsec/plugins/" 105 metabase: 106 name: metabase 107 url: https://bitbucket.org/Aishee/synsec 108 wizard: 109 name: wizard 110 url: "https://bitbucket.org/Aishee/synsec" 111 bin: "./wizard.sh" 112 bugreport: "https://bitbucket.org/Aishee/synsec/issues" 113 ref: 114 parser: "[parser](/Synsec/v0/references/parsers/)" 115 Parser: "[Parser](/Synsec/v0/references/parsers/)" 116 scenario: "[scenarios](/Synsec/v0/references/scenarios/)" 117 Scenario: "[Scenarios](/Synsec/v0/references/scenarios/)" 118 acquis: "[acquisition](/Synsec/v0/guide/synsec/acquisition/)" 119 Acquis: "[Acquisition](/Synsec/v0/guide/synsec/acquisition/)" 120 output: "[output](/Synsec/v0/references/output/)" 121 Output: "[Output](/Synsec/v0/references/output/)" 122 # All the technical terms 123 event: 124 name: event 125 Name: Event 126 htmlname: "[event](/Synsec/v0/getting_started/concepts/#event)" 127 Htmlname: "[Event](/Synsec/v0/getting_started/concepts/#event)" 128 expr: 129 name: expr 130 Name: Expr 131 htmlname: "[expr](/Synsec/v0/write_configurations/expressions/)" 132 Htmlname: "[Expr](/Synsec/v0/write_configurations/expressions/)" 133 filter: 134 name: filter 135 Name: Filter 136 htmlname: "[filter](/Synsec/v0/references/parsers/#filter)" 137 Htmlname: "[Filter](/Synsec/v0/references/parsers/#filter)" 138 onsuccess: 139 name: onsuccess 140 Name: Onsuccess 141 htmlname: "[onsuccess](/Synsec/v0/references/parsers/#onsuccess)" 142 Htmlname: "[Onsuccess](/Synsec/v0/references/parsers/#onsuccess)" 143 statics: 144 name: statics 145 Name: Statics 146 htmlname: "[statics](/Synsec/v0/references/parsers/#statics)" 147 Htmlname: "[Statics](/Synsec/v0/references/parsers/#statics)" 148 parsers: 149 name: parsers 150 Name: Parsers 151 htmlname: "[parsers](/Synsec/v0/getting_started/concepts/#parsers)" 152 Htmlname: "[Parsers](/Synsec/v0/getting_started/concepts/#parsers)" 153 scenarios: 154 name: scenarios 155 Name: Scenarios 156 htmlname: "[scenarios](/Synsec/v0/getting_started/concepts/#scenarios)" 157 Htmlname: "[Scenarios](/Synsec/v0/getting_started/concepts/#scenarios)" 158 collections: 159 name: collections 160 Name: Collections 161 htmlname: "[collections](/Synsec/v0/getting_started/concepts/#collections)" 162 Htmlname: "[Collections](/Synsec/v0/getting_started/concepts/#collections)" 163 timeMachine: 164 name: timeMachine 165 Name: TimeMachine 166 htmlname: "[timeMachine](/Synsec/v0/getting_started/concepts/#timemachine)" 167 Htmlname: "[TimeMachine](/Synsec/v0/getting_started/concepts/#timemachine)" 168 overflow: 169 name: overflow 170 Name: Overflow 171 htmlname: "[overflow](/Synsec/v0/getting_started/concepts/#overflow-or-signaloccurence)" 172 Htmlname: "[Overflow](/Synsec/v0/getting_started/concepts/#overflow-or-signaloccurence)" 173 whitelists: 174 name: whitelists 175 Name: Whitelists 176 htmlname: "[whitelists](/Synsec/v0/write_configurations/whitelist/)" 177 Htmlname: "[Whitelists](/Synsec/v0/write_configurations/whitelist/)" 178 signal: 179 name: signal 180 Name: Signal 181 htmlname: "[signal](/Synsec/v0/getting_started/concepts/#overflow-or-signaloccurence)" 182 Htmlname: "[Signal](/Synsec/v0/getting_started/concepts/#overflow-or-signaloccurence)" 183 #scenario stuff 184 stage: 185 name: stage 186 Name: Stage 187 htmlname: "[stage](/Synsec/v0/getting_started/concepts/#stages)" 188 Htmlname: "[Stage](/Synsec/v0/getting_started/concepts/#stages)" 189 leakspeed: 190 name: leakspeed 191 Name: Leakspeed 192 htmlname: "[leakspeed](/Synsec/v0/references/scenarios/#leakspeed)" 193 Htmlname: "[Leakspeed](/Synsec/v0/references/scenarios/#leakspeed)" 194 capacity: 195 name: capacity 196 Name: Capacity 197 htmlname: "[capacity](/Synsec/v0/references/scenarios/#capacity)" 198 Htmlname: "[Capacity](/Synsec/v0/references/scenarios/#capacity)" 199 duration: 200 name: duration 201 Name: Duration 202 htmlname: "[duration](/Synsec/v0/references/scenarios/#duration)" 203 Htmlname: "[Duration](/Synsec/v0/references/scenarios/#duration)" 204 prometheus: 205 name: prometheus 206 htmlname: "[prometheus](https://github.com/prometheus/client_golang)" 207 api: 208 name: API 209 htmlname: "[API](TBD)" 210 topX: 211 name: topX 212 htmlname: "[topX](TBD)" 213 ############################################################### 214 ### Bellow are defines for V1 and later of the documentation ## 215 ############################################################### 216 v1X: 217 doc: 218 new_issue: "[new documentation issue](https://bitbucket.org/Aishee/synsec/issues/new)" 219 discourse: "[BreakTeam discourse](http://discourse.synsec.net)" 220 community: "[community](http://discourse.synsec.net)" 221 hub: 222 name: Synsec Hub 223 htmlname: "[Synsec Hub](https://hub.synsec.net/)" 224 url: "https://hub.synsec.net/" 225 bouncers_url: "https://hub.synsec.net/browse/#bouncers" 226 scenarios_url: "https://hub.synsec.net/browse/#configurations" 227 parsers_url: "https://hub.synsec.net/browse/#configurations" 228 collections_url: "https://hub.synsec.net/browse/#collections" 229 synsec: 230 name: synsec-agent 231 Name: Synsec-agent 232 url: https://bitbucket.org/Aishee/synsec 233 bugreport: "https://bitbucket.org/Aishee/synsec/issues" 234 download_url: https://bitbucket.org/Aishee/synsec/releases 235 lapi: 236 name: local API (LAPI) 237 Name: Local API (LAPI) 238 Htmlname: "[Local API](/Synsec/v1/localAPI/)" 239 htmlname: "[local API](/Synsec/v1/localAPI/)" 240 url: /Synsec/v1/localAPI/ 241 swagger: https://breakteam.github.io/api_doc/index.html?urls.primaryName=LAPI 242 cli: 243 name: ccscli 244 Name: Cscli 245 bin: ccscli 246 user_guide: "[ccscli](/Synsec/v1/user_guide/ccscli/)" 247 config: 248 synsec_dir: "/etc/synsec/" 249 acquis_path: "/etc/synsec/acquis.yaml" 250 synsec_config_file: "/etc/synsec/config.yaml" 251 bouncers: 252 name: bouncers 253 Name: Bouncers 254 url: "https://hub.synsec.net/browse/#bouncers" 255 htmlname: "[bouncers](/Synsec/v1/bouncers/)" 256 Htmlname: "[bouncers](/Synsec/v1/bouncers/)" 257 metabase: 258 name: metabase 259 htmlName: "[dashboard](/Synsec/v1/observability/dashboard)" 260 wizard: 261 name: wizard 262 bin: "./wizard.sh" 263 bugreport: "https://bitbucket.org/Aishee/synsec/issues" 264 ref: 265 acquis: "[acquisition](/Synsec/v1/user_guide/configurations_management/acquisition/)" 266 parsers: "[parsers](/Synsec/v1/references/parsers/)" 267 scenarios: "[scenarios](/Synsec/v1/references/scenarios/)" 268 # All the technical terms 269 event: 270 name: event 271 Name: Event 272 htmlname: "[event](/Synsec/v1/getting_started/concepts/#events)" 273 Htmlname: "[Event](/Synsec/v1/getting_started/concepts/#events)" 274 expr: 275 name: expr 276 Name: Expr 277 htmlname: "[expr](/Synsec/v1/references/expressions/)" 278 Htmlname: "[Expr](/Synsec/v1/references/expressions/)" 279 filter: 280 name: filter 281 Name: Filter 282 htmlname: "[filter](/Synsec/v1/references/parsers/#filter)" 283 Htmlname: "[Filter](/Synsec/v1/references/parsers/#filter)" 284 onsuccess: 285 name: onsuccess 286 Name: Onsuccess 287 htmlname: "[onsuccess](/Synsec/v1/references/parsers/#onsuccess)" 288 Htmlname: "[Onsuccess](/Synsec/v1/references/parsers/#onsuccess)" 289 profiles: 290 htmlname: "[profiles](/Synsec/v1/references/profiles/)" 291 simulation: 292 htmlname: "[profiles](/Synsec/v1/references/simulation/)" 293 statics: 294 name: statics 295 Name: Statics 296 htmlname: "[statics](/Synsec/v1/references/parsers/#statics)" 297 Htmlname: "[Statics](/Synsec/v1/references/parsers/#statics)" 298 parsers: 299 name: parsers 300 Name: Parsers 301 htmlname: "[parsers](/Synsec/v1/getting_started/concepts/#parsers)" 302 Htmlname: "[Parsers](/Synsec/v1/getting_started/concepts/#parsers)" 303 scenarios: 304 name: scenarios 305 Name: Scenarios 306 htmlname: "[scenarios](/Synsec/v1/getting_started/concepts/#scenarios)" 307 Htmlname: "[Scenarios](/Synsec/v1/getting_started/concepts/#scenarios)" 308 collections: 309 name: collections 310 Name: Collections 311 htmlname: "[collections](/Synsec/v1/getting_started/concepts/#collections)" 312 Htmlname: "[Collections](/Synsec/v1/getting_started/concepts/#collections)" 313 timeMachine: 314 name: timeMachine 315 Name: TimeMachine 316 htmlname: "[timeMachine](/Synsec/v1/getting_started/concepts/#timemachine)" 317 Htmlname: "[TimeMachine](/Synsec/v1/getting_started/concepts/#timemachine)" 318 alert: 319 name: alert 320 Name: Alert 321 htmlname: "[alert](/Synsec/v1/getting_started/concepts/#alerts)" 322 Htmlname: "[Alert](/Synsec/v1/getting_started/concepts/#alerts)" 323 decision: 324 name: decision 325 Name: Decision 326 htmlname: "[decision](/Synsec/v1/getting_started/concepts/#decisions)" 327 Htmlname: "[Decision](/Synsec/v1/getting_started/concepts/#decisions)" 328 whitelists: 329 name: whitelists 330 Name: Whitelists 331 htmlname: "[whitelists](/Synsec/v1/write_configurations/whitelist/)" 332 Htmlname: "[Whitelists](/Synsec/v1/write_configurations/whitelist/)" 333 #scenario stuff 334 stage: 335 name: stage 336 Name: Stage 337 htmlname: "[stage](/Synsec/v1/getting_started/concepts/#stages)" 338 Htmlname: "[Stage](/Synsec/v1/getting_started/concepts/#stages)" 339 leakspeed: 340 name: leakspeed 341 Name: Leakspeed 342 htmlname: "[leakspeed](/Synsec/v1/references/scenarios/#leakspeed)" 343 Htmlname: "[Leakspeed](/Synsec/v1/references/scenarios/#leakspeed)" 344 capacity: 345 name: capacity 346 Name: Capacity 347 htmlname: "[capacity](/Synsec/v1/references/scenarios/#capacity)" 348 Htmlname: "[Capacity](/Synsec/v1/references/scenarios/#capacity)" 349 duration: 350 name: duration 351 Name: Duration 352 htmlname: "[duration](/Synsec/v1/references/scenarios/#duration)" 353 Htmlname: "[Duration](/Synsec/v1/references/scenarios/#duration)" 354 prometheus: 355 name: prometheus 356 htmlname: "[prometheus](https://github.com/prometheus/client_golang)" 357 api: 358 name: API 359 htmlname: "[API](TBD)" 360 topX: 361 name: topX 362 htmlname: "[topX](TBD)"