diff --git a/README.md b/README.md index 81350ed..b42f0ec 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# MorkNetVisualizer +# mNetVisualizer 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 @@ -16,7 +16,7 @@ devices are connecting to and where inbound traffic originates from. ## Download -[Download v1.0 tar.gz](https://github.com/danielmorkcode/MorkNetVisualizer/releases/download/v1.0.0/netmapFinal.tar.gz) +[Download v1.0 tar.gz](https://github.com/danielmorkcode/mNetVisualizer/releases/download/v1.0.0/netmapFinal.tar.gz) Or clone the repository and build from source. @@ -107,7 +107,7 @@ See the CrowdSec section below. ``` git clone -cd MorkNetVisualizer +cd mNetVisualizer ``` ### 2. Place the GeoIP database @@ -181,14 +181,14 @@ CROWDSEC_API_KEY= ## CrowdSec integration (optional) -CrowdSec is an open source threat detection tool. When configured, MorkNetVisualizer will +CrowdSec is an open source threat detection tool. When configured, mNetVisualizer 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 MorkNetVisualizer container. +CrowdSec must be running on a host reachable from the mNetVisualizer 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: @@ -208,7 +208,7 @@ sudo systemctl restart crowdsec Create a bouncer API key: ``` -sudo cscli bouncers add MorkNetVisualizer-reader +sudo cscli bouncers add mNetVisualizer-reader ``` Copy the generated key. Then in `backend/.env`: