vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2026-04-08 03:01:29 -07:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

📚Docs: SyncHub Use case by @richtj999 🙏 #788

Browse Source
This commit is contained in:
jokob-sk
2024-10-19 10:09:36 +11:00
parent 987127302c
commit 367a024860
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
front/plugins/sync/README.md
View File

@@ -64,7 +64,7 @@ The plugin operates in three different modes based on the configuration settings
### Example use case: Network Setup with Multiple VLANs and VM Scanning ### Example use case: Network Setup with Multiple VLANs and VM Scanning
> Thank you to @richtj999 for the use case 🙏 > Thank you to [@richtj999](https://github.com/richtj999) for the use case 🙏
I have 6 VLANs, all isolated by a firewall, except for one VLAN that has access to all the others. I have 6 VLANs, all isolated by a firewall, except for one VLAN that has access to all the others.
@@ -74,12 +74,12 @@ Initially, I had one virtual machine (VM) with 6 network cards, one for each VLA
- One VM acts as the "server," and the other 5 as "clients." - One VM acts as the "server," and the other 5 as "clients."
- The server has access to all VLANs (via firewall rules) and collects data from the client VMs, which each scan their own VLAN. - The server has access to all VLANs (via firewall rules) and collects data from the client VMs, which each scan their own VLAN.
### Summary #### Summary
- **Single VM on six VLANs**: Slower because one VM scans all networks. - **Single VM on six VLANs**: Slower because one VM scans all networks.
- **Six VMs on six VLANs**: Faster because each VM scans its own network, sending the results to the server. - **Six VMs on six VLANs**: Faster because each VM scans its own network, sending the results to the server.
### Example Setup #### Example Setup
- **VM1 ("Server")**: Network 1 (can access all networks) - IP: `10.10.10.106` - **VM1 ("Server")**: Network 1 (can access all networks) - IP: `10.10.10.106`
Receives data from all NetAlertX clients and scans network 1. Receives data from all NetAlertX clients and scans network 1.
@@ -101,9 +101,9 @@ Initially, I had one virtual machine (VM) with 6 network cards, one for each VLA
--- ---
## How to Set It Up #### How to Set It Up
### Server (VM1) ##### Server (VM1)
1. Go to **Settings > System > Sync Hub**. 1. Go to **Settings > System > Sync Hub**.
2. Set the schedule (5 minutes works for me). 2. Set the schedule (5 minutes works for me).
@@ -113,7 +113,7 @@ Initially, I had one virtual machine (VM) with 6 network cards, one for each VLA
6. **Node Name**: Leave blank. 6. **Node Name**: Leave blank.
7. Check **Sync Devices**. 7. Check **Sync Devices**.
### Clients (VM2, VM3, VM4, VM5, VM6) ##### Clients (VM2, VM3, VM4, VM5, VM6)
1. Go to **Settings > System > Sync Hub**. 1. Go to **Settings > System > Sync Hub**.
2. Set **When to run** to "Always after scan." 2. Set **When to run** to "Always after scan."