diff --git a/README.md b/README.md index b21f3a9..6333610 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# NetMap +# MorkNetVisualizer 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 @@ -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 - Captures real network flows via NetFlow v9/IPFIX from your router @@ -100,7 +108,7 @@ See the CrowdSec section below. ``` git clone -cd netmap +cd MorkNetVisualizer ``` ### 2. Place the GeoIP database @@ -174,14 +182,14 @@ CROWDSEC_API_KEY= ## 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 pulse animation. You can filter between locally detected bans and the community blocklist. ### 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 remote access from another host, edit `/etc/crowdsec/config.yaml` on the CrowdSec host: @@ -201,7 +209,7 @@ sudo systemctl restart crowdsec 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`: