cphipps/NetAlertX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add german readme to arp_scan plugin, format config file

Browse Source
This commit is contained in:
Markus Lorenz
2023-10-09 11:32:55 +02:00
parent dcf785b900
commit 1a02d34e85
2 changed files with 358 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
front/plugins/arp_scan/README_DE.md Executable file
View File

@@ -0,0 +1,12 @@
## Übersicht
ARP-Scan ist ein Kommandozeilen Werkzeug welches das ARP-Protokoll nutzt, um IP-Hosts im lokalen Netzwerk zu erkennen und identifizieren. Eine Alternative zum ARP-Scan ist die Aktivierung der PiHole-Integration (`PIHOLE_RUN`) in den Einstellungen. Die Dauer des ARP-Scan (und andere Netzwerkscan-Plugins, welche die `SCAN_SUBNETS`-Einstellung nutzen) ist abhängig von der Anzahl der zu prüfenden IP-Adressen. Daher ist es wichtig, dies mit größter Vorsicht und den korrekten Netzwerkmasken und -interfaces zu konfigurieren. Die [Subnetz-Dokumentation](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/SUBNETS.md) ansehen für mehr Hilfe zum Aufsetzen von VLANs, welche VLANs unterstützt werden und zum Herausfinden der Netzwerkmaske und -interfaces.
### Verwendung
- Zur Einstellungen-Seite gehen und die `SCAN_SUBNETS`-Einstellung anhand der [Subnetz-Dokumentation](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/SUBNETS.md) konfigurieren
- Das Plugin aktivieren indem der `RUN`-Parameter von `disabled` auf den gewünschten Ausführzeitpunkt gesetzt wird (normalerweise: `schedule`)
- Zeitplan in der `ARPSCAN_RUN_SCHD`-Einstellung setzen
- Zeitlimit nach Bedarf in der `ARPSCAN_RUN_TIMEOUT`-Einstellung setzen
- SPEICHERN
- Auf Ausführung des nächsten Scans warten

178
front/plugins/arp_scan/config.json
View File

@@ -14,8 +14,11 @@
}
],
"show_ui": true,
"localized": ["display_name", "description", "icon"],
"localized": [
"display_name",
"description",
"icon"
],
"display_name": [
{
"language_code": "en_us",
@@ -64,16 +67,27 @@
"type": "setting",
"value": "SCAN_SUBNETS",
"base64": true
}],
}
],
"settings": [
{
"function": "RUN",
"type": "text.select",
"default_value": "schedule",
"options": ["disabled", "once", "schedule", "always_after_scan", "on_new_device"],
"localized": ["name", "description"],
"events": ["run"],
"options": [
"disabled",
"once",
"schedule",
"always_after_scan",
"on_new_device"
],
"localized": [
"name",
"description"
],
"events": [
"run"
],
"name": [
{
"language_code": "en_us",
@@ -86,8 +100,10 @@
{
"language_code": "de_de",
"string": "Wann ausführen"
}],
"description": [{
}
],
"description": [
{
"language_code": "en_us",
"string": "Specify when your Network-discovery scan will run. Typical setting would be <code>schedule</code> and then you specify a cron-like schedule in the <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code>setting</a> "
},
@@ -98,14 +114,18 @@
{
"language_code": "de_de",
"string": "Auswählen wann der Netzwerkscan laufen soll. Typischerweise wird <code>schedule</code> ausgewählt und ein cron-Intervall in der <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code>Einstellung</a> gesetzt."
}]
}
]
},
{
"function": "CMD",
"type": "readonly",
"default_value": "python3 /home/pi/pialert/front/plugins/arp_scan/script.py userSubnets={subnets}",
"options": [],
"localized": ["name", "description"],
"localized": [
"name",
"description"
],
"name": [
{
"language_code": "en_us",
@@ -135,13 +155,15 @@
}
]
},
{
"function": "RUN_TIMEOUT",
"type": "integer",
"default_value": 300,
"options": [],
"localized": ["name", "description"],
"localized": [
"name",
"description"
],
"name": [
{
"language_code": "en_us",
@@ -176,8 +198,12 @@
"type": "text",
"default_value": "*/5 * * * *",
"options": [],
"localized": ["name", "description"],
"name" : [{
"localized": [
"name",
"description"
],
"name": [
{
"language_code": "en_us",
"string": "Schedule"
},
@@ -188,8 +214,10 @@
{
"language_code": "de_de",
"string": "Zeitplan"
}],
"description": [{
}
],
"description": [
{
"language_code": "en_us",
"string": "Only enabled if you select <code>schedule</code> in the <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). For example entering <code>*/3 * * * *</code> will run the scan every 3 minutes. Will be run NEXT time the time passes. <br/> It's recommended to use the same schedule interval for all plugins responsible for discovering new devices."
},
@@ -200,15 +228,28 @@
{
"language_code": "de_de",
"string": "Nur aktiv, wenn <code>schedule</code> in der <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code> Einstellung</a> ausgewählt wurde. Sichergehen, dass das Intervall in einem korrekten cron-ähnlichen Format angegeben wurde (z.B. auf <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a> testen). <code>*/3 * * * *</code> würde den Scan alle 3 Minuten starten. Wird erst beim NÄCHSTEN Intervall ausgeführt. <br/>Es wird empfohlen, das Intervall aller Plugins, welche nach neuen Geräten suchen, auf den gleichen Wert zu setzen."
}]
}
]
},
{
"function": "WATCH",
"type": "text.multiselect",
"default_value":["Watched_Value1", "Watched_Value2"],
"options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"],
"localized": ["name", "description"],
"name" :[{
"default_value": [
"Watched_Value1",
"Watched_Value2"
],
"options": [
"Watched_Value1",
"Watched_Value2",
"Watched_Value3",
"Watched_Value4"
],
"localized": [
"name",
"description"
],
"name": [
{
"language_code": "en_us",
"string": "Watched"
},
@@ -219,8 +260,10 @@
{
"language_code": "de_de",
"string": "Überwacht"
}] ,
"description":[{
}
],
"description": [
{
"language_code": "en_us",
"string": "Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is IP</li><li><code>Watched_Value2</code> is Vendor</li><li><code>Watched_Value3</code> is Interface </li><li><code>Watched_Value4</code> is N/A </li></ul>"
},
@@ -231,14 +274,25 @@
{
"language_code": "de_de",
"string": "Sende eine Benachrichtigung, wenn ein ausgwählter Wert sich ändert. <code>STRG + klicken</code> zum aus-/abwählen. <ul> <li><code>Watched_Value1</code> ist die IP</li><li><code>Watched_Value2</code> ist der Hersteller</li><li><code>Watched_Value3</code> ist das Interface </li><li><code>Watched_Value4</code> ist nicht in Verwendung </li></ul>"
}]
}
]
},
{
"function": "REPORT_ON",
"type": "text.multiselect",
"default_value": ["new"],
"options": ["new", "watched-changed", "watched-not-changed", "missing-in-last-scan"],
"localized": ["name", "description"],
"default_value": [
"new"
],
"options": [
"new",
"watched-changed",
"watched-not-changed",
"missing-in-last-scan"
],
"localized": [
"name",
"description"
],
"name": [
{
"language_code": "en_us",
@@ -269,9 +323,7 @@
]
}
],
"database_column_definitions":
[
"database_column_definitions": [
{
"column": "Object_PrimaryID",
"mapped_to_column": "cur_MAC",
@@ -280,8 +332,11 @@
"type": "device_name_mac",
"default_value": "",
"options": [],
"localized": ["name"],
"name":[{
"localized": [
"name"
],
"name": [
{
"language_code": "en_us",
"string": "MAC"
},
@@ -292,7 +347,8 @@
{
"language_code": "de_de",
"string": "MAC"
}]
}
]
},
{
"column": "Watched_Value1",
@@ -302,8 +358,11 @@
"type": "device_ip",
"default_value": "",
"options": [],
"localized": ["name"],
"name":[{
"localized": [
"name"
],
"name": [
{
"language_code": "en_us",
"string": "IP"
},
@@ -314,7 +373,8 @@
{
"language_code": "de_de",
"string": "IP"
}]
}
]
},
{
"column": "Watched_Value2",
@@ -324,8 +384,11 @@
"type": "label",
"default_value": "",
"options": [],
"localized": ["name"],
"name":[{
"localized": [
"name"
],
"name": [
{
"language_code": "en_us",
"string": "Vendor"
},
@@ -336,7 +399,8 @@
{
"language_code": "de_de",
"string": "Hersteller"
}]
}
]
},
{
"column": "Dummy",
@@ -349,8 +413,11 @@
"type": "label",
"default_value": "",
"options": [],
"localized": ["name"],
"name":[{
"localized": [
"name"
],
"name": [
{
"language_code": "en_us",
"string": "Scan method"
},
@@ -361,7 +428,8 @@
{
"language_code": "de_de",
"string": "Scanmethode"
}]
}
]
},
{
"column": "DateTimeCreated",
@@ -370,8 +438,11 @@
"type": "label",
"default_value": "",
"options": [],
"localized": ["name"],
"name":[{
"localized": [
"name"
],
"name": [
{
"language_code": "en_us",
"string": "Created"
},
@@ -382,7 +453,8 @@
{
"language_code": "de_de",
"string": "Erstellt"
}]
}
]
},
{
"column": "DateTimeChanged",
@@ -391,7 +463,9 @@
"type": "label",
"default_value": "",
"options": [],
"localized": ["name"],
"localized": [
"name"
],
"name": [
{
"language_code": "en_us",
@@ -431,8 +505,11 @@
"replacement": "<div style='text-align:center'><i class='fa-solid fa-question'></i></div>"
}
],
"localized": ["name"],
"name":[{
"localized": [
"name"
],
"name": [
{
"language_code": "en_us",
"string": "Status"
},
@@ -443,7 +520,8 @@
{
"language_code": "de_de",
"string": "Status"
}]
}
]
}
]
}