mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-06-20 22:30:11 -04:00
Merge branch 'next_release' of github.com:netalertx/NetAlertX into next_release
This commit is contained in:
49
docs/REST_IMPORT.md
Executable file
49
docs/REST_IMPORT.md
Executable file
@@ -0,0 +1,49 @@
|
||||
# RSTIMPRT plugin OPNsense/Dnsmasq setup
|
||||
|
||||
This guide shows you how to configure **OPNsense/Dnsmasq** in the **RSTIMPRT** plugin.
|
||||
|
||||
|
||||
|
||||
## 1. Create an OPNsense user
|
||||
1. In OPNsense, navigate to **System** → **Access** → **Users**
|
||||
2. Click the **+** to add a new user
|
||||
3. Give your user a name (e.g., `netalertx`) and a Full name (e.g., `NetAlertX`)
|
||||
4. Assign privilege: `Services: Dnsmasq DNS/DHCP: Settings`
|
||||
5. Click **Save**
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
## 2. Create an OPNsense API key
|
||||
1. On the OPNsense Users screen, click the **AP Key** button next to your new user
|
||||

|
||||
2. Click **Yes** when prompted to generate and download the new key. You'll receive a text file with a `key` and a `secret`.
|
||||

|
||||
|
||||
|
||||
|
||||
## 3. Configure the RSTIMPRT plugin
|
||||
1. In NetAlertX, navigate to **Settings** → **Core** → **Loaded plugins** and add `RSTIMPRT`
|
||||
2. Click **Save**
|
||||
3. Navigate to **Settings** → **Core** → **Device scanners** and expand `RSTIMPRT`
|
||||
4. Under **RSTIMPRT_imports**, click **Add**
|
||||
5. Enter the following connection info:
|
||||
- Name: Whatever you'd like to call this REST instance (e.g., `OPNsense Dnsmasq`)
|
||||
- URL: Full URL to the API endpoint (e.g., `https://192.168.1.1:8443/api/dnsmasq/leases/search`)
|
||||
- Method: `GET`
|
||||
- Auth Type: `basic`
|
||||
- Username / API Key: The `key` value from your downloaded API key file
|
||||
- Password / API Secret: The `secret` value from your downloaded API key file
|
||||

|
||||
|
||||
6. In the same window, enter the following field mappings:
|
||||
- Device List Path: `rows`
|
||||
- MAC Address: `hwaddr`
|
||||
- IP Address: `address`
|
||||
- Device Name: `hostname`
|
||||
- Vendor: `mac_info`
|
||||

|
||||
|
||||
7. Click **Update**
|
||||
8. Click **Save**
|
||||
BIN
docs/img/REST_IMPORT/opnsense_user.png
Normal file
BIN
docs/img/REST_IMPORT/opnsense_user.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
BIN
docs/img/REST_IMPORT/opnsense_user_api_key.png
Normal file
BIN
docs/img/REST_IMPORT/opnsense_user_api_key.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.5 KiB |
BIN
docs/img/REST_IMPORT/opnsense_user_api_key_confirm.png
Normal file
BIN
docs/img/REST_IMPORT/opnsense_user_api_key_confirm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
BIN
docs/img/REST_IMPORT/rstimport_config_1.png
Normal file
BIN
docs/img/REST_IMPORT/rstimport_config_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
BIN
docs/img/REST_IMPORT/rstimport_config_2.png
Normal file
BIN
docs/img/REST_IMPORT/rstimport_config_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
@@ -807,5 +807,8 @@
|
||||
"settings_system_icon": "fa-solid fa-gear",
|
||||
"settings_system_label": "Système",
|
||||
"settings_update_item_warning": "Mettre à jour la valeur ci-dessous. Veillez à bien suivre le même format qu'auparavant. <b>Il n'y a pas de pas de contrôle.</b>",
|
||||
"test_event_tooltip": "Enregistrer d'abord vos modifications avant de tester vôtre paramétrage."
|
||||
"test_event_tooltip": "Enregistrer d'abord vos modifications avant de tester vôtre paramétrage.",
|
||||
"WF_Action_target": "Appliquer l'action à",
|
||||
"WF_Action_target_conditions": "Cibler des conditions de l'appareil",
|
||||
"WF_Action_token_hint": "Utiliser <code>{{trigger.COLUMN}}</code> pour référencer l'appareil déclencheur (par ex. <code>{{trigger.devLastIP}}</code>, <code>{{trigger.devMac}}</code>)"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user