dmo/MorkNetVisualizer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
DMO
2026-06-07 19:47:05 +02:00
committed by GitHub
parent 5f8a43e652
commit ae062a04ed
1 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -5
View File
@@ -1,4 +1,4 @@
# NetMap # MorkNetVisualizer
A real-time network traffic visualization tool for home and small office networks. A real-time network traffic visualization tool for home and small office networks.
It displays live traffic flows as animated arcs on a world map, showing where your It displays live traffic flows as animated arcs on a world map, showing where your
@@ -15,6 +15,14 @@ adding authentication in front of it (e.g. via a reverse proxy with access contr
--- ---
## Download
[Download v1.0 tar.gz](https://github.com/danielmorkcode/MorkNetVisualizer/releases/download/v1.0.0/netmapFinal.tar.gz)
Or clone the repository and build from source.
---
## What it does ## What it does
- Captures real network flows via NetFlow v9/IPFIX from your router - Captures real network flows via NetFlow v9/IPFIX from your router
@@ -100,7 +108,7 @@ See the CrowdSec section below.
``` ```
git clone <your-repo-url> git clone <your-repo-url>
cd netmap cd MorkNetVisualizer
``` ```
### 2. Place the GeoIP database ### 2. Place the GeoIP database
@@ -174,14 +182,14 @@ CROWDSEC_API_KEY=
## CrowdSec integration (optional) ## CrowdSec integration (optional)
CrowdSec is an open source threat detection tool. When configured, NetMap will CrowdSec is an open source threat detection tool. When configured, MorkNetVisualizer will
display banned IPs as red X markers on the map, with new bans showing a brief display banned IPs as red X markers on the map, with new bans showing a brief
pulse animation. You can filter between locally detected bans and the community pulse animation. You can filter between locally detected bans and the community
blocklist. blocklist.
### Setup ### Setup
CrowdSec must be running on a host reachable from the NetMap container. CrowdSec must be running on a host reachable from the MorkNetVisualizer container.
By default, CrowdSec only listens on localhost (127.0.0.1:8080). To allow By default, CrowdSec only listens on localhost (127.0.0.1:8080). To allow
remote access from another host, edit `/etc/crowdsec/config.yaml` on the remote access from another host, edit `/etc/crowdsec/config.yaml` on the
CrowdSec host: CrowdSec host:
@@ -201,7 +209,7 @@ sudo systemctl restart crowdsec
Create a bouncer API key: Create a bouncer API key:
``` ```
sudo cscli bouncers add netmap-reader sudo cscli bouncers add MorkNetVisualizer-reader
``` ```
Copy the generated key. Then in `backend/.env`: Copy the generated key. Then in `backend/.env`: