Compare commits

..
2 Commits
Author SHA1 Message Date
dmo 78a37cddb6 Update README.md
Updated doc with new name
2026-08-04 13:12:11 +02:00
dmo 0151902125 Update README.md
Updated AI Important disclaimer
2026-08-04 10:42:59 +02:00
+10 -11
View File
@@ -1,4 +1,4 @@
# MorkNetVisualizer # mNetVisualizer
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
@@ -7,17 +7,16 @@ devices are connecting to and where inbound traffic originates from.
--- ---
## Important disclaimer ## Important disclaimer
> [!Important]
This project was built entirely through AI-assisted development (Claude by Anthropic). > This project was built entirely through AI-assisted development (Claude by Anthropic).\
No human has audited, reviewed, or manually written the code. Use it at your own risk > No human has audited, reviewed, or manually written the code. Use it at your own risk in trusted network environments.\
in trusted network environments. Do not expose it to the public internet without > **Do not expose it to the public internet without adding authentication in front of it (e.g. via a reverse proxy with access control).**
adding authentication in front of it (e.g. via a reverse proxy with access control).
--- ---
## Download ## 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. Or clone the repository and build from source.
@@ -108,7 +107,7 @@ See the CrowdSec section below.
``` ```
git clone <your-repo-url> git clone <your-repo-url>
cd MorkNetVisualizer cd mNetVisualizer
``` ```
### 2. Place the GeoIP database ### 2. Place the GeoIP database
@@ -182,14 +181,14 @@ CROWDSEC_API_KEY=
## CrowdSec integration (optional) ## 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 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 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 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:
@@ -209,7 +208,7 @@ sudo systemctl restart crowdsec
Create a bouncer API key: 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`: Copy the generated key. Then in `backend/.env`: