mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2025-12-06 07:12:04 +01:00
add documentation
This commit is contained in:
parent
82bb50f2cb
commit
3354a7d5f2
42
docu/docs/plugin/mysql.md
Normal file
42
docu/docs/plugin/mysql.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# <center>Mysql</center>
|
||||
---
|
||||
|
||||
## Beschreibung
|
||||
Mit diesem Plugin ist es moeglich, die Alarmierungen in einer Mysql / Mariadb Datenbank zu speichern.
|
||||
|
||||
## Unterstütze Alarmtypen
|
||||
- Fms
|
||||
- Pocsag
|
||||
- Zvei
|
||||
- Msg
|
||||
|
||||
## Resource
|
||||
`mysql`
|
||||
|
||||
## Konfiguration
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|host|IP-Adresse bzw. URL des Hosts||
|
||||
|user|Username||
|
||||
|password|Passwort||
|
||||
|database|Name der Datenbank||
|
||||
|
||||
**Beispiel:**
|
||||
```yaml
|
||||
- type: plugin
|
||||
name: mysql
|
||||
res: mysql
|
||||
config:
|
||||
host: HOST
|
||||
user: USERNAME
|
||||
password: PASSWORD
|
||||
database: DATABASE
|
||||
```
|
||||
|
||||
---
|
||||
## Modul Abhängigkeiten
|
||||
- keine
|
||||
|
||||
---
|
||||
## Externe Abhängigkeiten
|
||||
- mysql-connector-python
|
||||
Loading…
Reference in a new issue