Skip to content

Commit b6c8f9b

Browse files
committed
Merge branch 'next_release' of github.com:netalertx/NetAlertX into next_release
2 parents 691a57d + cb3c8b7 commit b6c8f9b

7 files changed

Lines changed: 53 additions & 1 deletion

File tree

docs/REST_IMPORT.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# RSTIMPRT plugin OPNsense/Dnsmasq setup
2+
3+
This guide shows you how to configure **OPNsense/Dnsmasq** in the **RSTIMPRT** plugin.
4+
5+
6+
7+
## 1. Create an OPNsense user
8+
1. In OPNsense, navigate to **System****Access****Users**
9+
2. Click the **+** to add a new user
10+
3. Give your user a name (e.g., `netalertx`) and a Full name (e.g., `NetAlertX`)
11+
4. Assign privilege: `Services: Dnsmasq DNS/DHCP: Settings`
12+
5. Click **Save**
13+
14+
![REST_IMPORT > OPNsense user](./img/REST_IMPORT/opnsense_user.png)
15+
16+
17+
18+
## 2. Create an OPNsense API key
19+
1. On the OPNsense Users screen, click the **AP Key** button next to your new user
20+
![REST_IMPORT > OPNsense API key](./img/REST_IMPORT/opnsense_user_api_key.png)
21+
2. Click **Yes** when prompted to generate and download the new key. You'll receive a text file with a `key` and a `secret`.
22+
![REST_IMPORT > API key confirmation](./img/REST_IMPORT/opnsense_user_api_key_confirm.png)
23+
24+
25+
26+
## 3. Configure the RSTIMPRT plugin
27+
1. In NetAlertX, navigate to **Settings****Core****Loaded plugins** and add `RSTIMPRT`
28+
2. Click **Save**
29+
3. Navigate to **Settings****Core****Device scanners** and expand `RSTIMPRT`
30+
4. Under **RSTIMPRT_imports**, click **Add**
31+
5. Enter the following connection info:
32+
- Name: Whatever you'd like to call this REST instance (e.g., `OPNsense Dnsmasq`)
33+
- URL: Full URL to the API endpoint (e.g., `https://192.168.1.1:8443/api/dnsmasq/leases/search`)
34+
- Method: `GET`
35+
- Auth Type: `basic`
36+
- Username / API Key: The `key` value from your downloaded API key file
37+
- Password / API Secret: The `secret` value from your downloaded API key file
38+
![RSTIMPRT_imports configuration](./img/REST_IMPORT/rstimport_config_1.png)
39+
40+
6. In the same window, enter the following field mappings:
41+
- Device List Path: `rows`
42+
- MAC Address: `hwaddr`
43+
- IP Address: `address`
44+
- Device Name: `hostname`
45+
- Vendor: `mac_info`
46+
![RSTIMPRT_imports configuration](./img/REST_IMPORT/rstimport_config_2.png)
47+
48+
7. Click **Update**
49+
8. Click **Save**
82.2 KB
Loading
7.51 KB
Loading
10.5 KB
Loading
54.6 KB
Loading
45.7 KB
Loading

front/php/templates/language/fr_fr.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -807,5 +807,8 @@
807807
"settings_system_icon": "fa-solid fa-gear",
808808
"settings_system_label": "Système",
809809
"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>",
810-
"test_event_tooltip": "Enregistrer d'abord vos modifications avant de tester vôtre paramétrage."
810+
"test_event_tooltip": "Enregistrer d'abord vos modifications avant de tester vôtre paramétrage.",
811+
"WF_Action_target": "Appliquer l'action à",
812+
"WF_Action_target_conditions": "Cibler des conditions de l'appareil",
813+
"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>)"
811814
}

0 commit comments

Comments
 (0)