Skip to content

Commit e65fea8

Browse files
RI-KaiRI-Kai
committed
Add screenshot
1 parent 8844b52 commit e65fea8

3 files changed

Lines changed: 75 additions & 76 deletions

File tree

‎LicenseInfo.md‎

Lines changed: 73 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,110 @@
1-
# Lizenzinformationen
1+
# License Information
22

3-
Dieses Dokument listet alle externen Komponenten, Bibliotheken, Frameworks und Datenquellen auf, die in NetFlowMap verwendet werden, zusammen mit ihren Lizenzen und Quellen.
3+
This document lists all external components, libraries, frameworks, and data sources used in NetFlowMap, along with their licenses and sources.
44

55
## Backend (Go)
66

7-
### Direkte Abhängigkeiten
7+
### Direct Dependencies
88

9-
| Komponente | Version | Quelle | Lizenz | Verwendung |
10-
|------------|---------|--------|--------|------------|
11-
| **go-chi/chi** | v5.2.3 | https://github.com/go-chi/chi | MIT License | HTTP-Router und Middleware |
12-
| **gorilla/websocket** | v1.5.3 | https://github.com/gorilla/websocket | BSD 2-Clause License | WebSocket-Kommunikation für Echtzeit-Updates |
13-
| **coreos/go-oidc** | v3.17.0 | https://github.com/coreos/go-oidc | Apache License 2.0 | OpenID Connect Authentifizierung |
14-
| **golang-jwt/jwt** | v5.3.0 | https://github.com/golang-jwt/jwt | MIT License | JWT-Token-Verarbeitung für Sessions |
15-
| **oschwald/maxminddb-golang** | v1.13.1 | https://github.com/oschwald/maxminddb-golang | Apache License 2.0 | GeoIP-Datenbank-Reader (MaxMind DB Format) |
16-
| **golang.org/x/crypto** | v0.46.0 | https://golang.org/x/crypto | BSD 3-Clause License | Kryptografische Funktionen (bcrypt für Passwort-Hashing) |
17-
| **golang.org/x/oauth2** | v0.34.0 | https://golang.org/x/oauth2 | BSD 3-Clause License | OAuth2-Client für OIDC |
18-
| **gopkg.in/yaml.v3** | v3.0.1 | https://github.com/go-yaml/yaml | Apache License 2.0 / MIT License | YAML-Konfigurationsparsing |
9+
| Component | Version | Source | License | Usage |
10+
|-----------|---------|--------|---------|-------|
11+
| **go-chi/chi** | v5.2.3 | https://github.com/go-chi/chi | MIT License | HTTP router and middleware |
12+
| **gorilla/websocket** | v1.5.3 | https://github.com/gorilla/websocket | BSD 2-Clause License | WebSocket communication for real-time updates |
13+
| **coreos/go-oidc** | v3.17.0 | https://github.com/coreos/go-oidc | Apache License 2.0 | OpenID Connect authentication |
14+
| **golang-jwt/jwt** | v5.3.0 | https://github.com/golang-jwt/jwt | MIT License | JWT token processing for sessions |
15+
| **oschwald/maxminddb-golang** | v1.13.1 | https://github.com/oschwald/maxminddb-golang | Apache License 2.0 | GeoIP database reader (MaxMind DB format) |
16+
| **golang.org/x/crypto** | v0.46.0 | https://golang.org/x/crypto | BSD 3-Clause License | Cryptographic functions (bcrypt for password hashing) |
17+
| **golang.org/x/oauth2** | v0.34.0 | https://golang.org/x/oauth2 | BSD 3-Clause License | OAuth2 client for OIDC |
18+
| **gopkg.in/yaml.v3** | v3.0.1 | https://github.com/go-yaml/yaml | Apache License 2.0 / MIT License | YAML configuration parsing |
1919

20-
### Indirekte Abhängigkeiten
20+
### Indirect Dependencies
2121

22-
| Komponente | Version | Quelle | Lizenz | Verwendung |
23-
|------------|---------|--------|--------|------------|
24-
| **go-jose/go-jose** | v4.1.3 | https://github.com/go-jose/go-jose | MIT License | JOSE-Implementierung (indirekt über go-oidc) |
25-
| **golang.org/x/sys** | v0.39.0 | https://golang.org/x/sys | BSD 3-Clause License | System-Calls (indirekt über andere Pakete) |
22+
| Component | Version | Source | License | Usage |
23+
|-----------|---------|--------|---------|-------|
24+
| **go-jose/go-jose** | v4.1.3 | https://github.com/go-jose/go-jose | MIT License | JOSE implementation (indirect via go-oidc) |
25+
| **golang.org/x/sys** | v0.39.0 | https://golang.org/x/sys | BSD 3-Clause License | System calls (indirect via other packages) |
2626

27-
### Programmiersprache
27+
### Programming Language
2828

29-
| Komponente | Version | Quelle | Lizenz | Verwendung |
30-
|------------|---------|--------|--------|------------|
31-
| **Go** | 1.25.3 | https://golang.org/ | BSD 3-Clause License | Programmiersprache |
29+
| Component | Version | Source | License | Usage |
30+
|-----------|---------|--------|---------|-------|
31+
| **Go** | 1.25.3 | https://golang.org/ | BSD 3-Clause License | Programming language |
3232

3333
## Frontend (JavaScript/CSS)
3434

35-
### JavaScript-Bibliotheken
35+
### JavaScript Libraries
3636

37-
| Komponente | Version | Quelle | Lizenz | Verwendung |
38-
|------------|---------|--------|--------|------------|
39-
| **Leaflet** | 1.9.4 | https://leafletjs.com/ | BSD 2-Clause License | Interaktive Kartenvisualisierung |
37+
| Component | Version | Source | License | Usage |
38+
|-----------|---------|--------|---------|-------|
39+
| **Leaflet** | 1.9.4 | https://leafletjs.com/ | BSD 2-Clause License | Interactive map visualization |
4040

41-
### Karten-Tiles (Externe Services)
41+
### Map Tiles (External Services)
4242

43-
| Komponente | Version | Quelle | Lizenz | Verwendung |
44-
|------------|---------|--------|--------|------------|
45-
| **CARTO Basemaps** | - | https://carto.com/basemaps/ | OpenStreetMap ODbL + CARTO Basemaps Terms of Service | Karten-Tiles für die Dark-Map-Ansicht |
46-
| **OpenStreetMap** | - | https://www.openstreetmap.org/ | Open Database License (ODbL) | Kartendatenquelle für CARTO Basemaps |
43+
| Component | Version | Source | License | Usage |
44+
|-----------|---------|--------|---------|-------|
45+
| **CARTO Basemaps** | - | https://carto.com/basemaps/ | OpenStreetMap ODbL + CARTO Basemaps Terms of Service | Map tiles for dark map view |
46+
| **OpenStreetMap** | - | https://www.openstreetmap.org/ | Open Database License (ODbL) | Map data source for CARTO Basemaps |
4747

48-
**Wichtiger Hinweis:**
49-
- CARTO Basemaps ist ein **externer Service** (keine Bibliothek), der zur Laufzeit über `cartocdn.com` aufgerufen wird
50-
- Die Karten-Tiles werden **nicht als Teil des Codes weiterverbreitet**, sondern werden zur Laufzeit vom CARTO-Server geladen
51-
- Die Attribution erfolgt automatisch im UI (siehe `web/static/js/app.js`)
52-
- CARTO Basemaps verwendet OpenStreetMap-Daten und stellt diese als kostenlosen Tile-Service zur Verfügung
53-
- **Nutzungsbedingungen:** Die spezifischen "Basemaps Terms of Service" von CARTO sollten direkt geprüft werden: https://carto.com/legal
54-
- Da es sich um einen externen Service handelt, der zur Laufzeit aufgerufen wird, verhindert dies **nicht** die Weiterverbreitung des NetFlowMap-Codes unter einer Open-Source-Lizenz
48+
**Important Note:**
49+
- CARTO Basemaps is an **external service** (not a library) that is called at runtime via `cartocdn.com`
50+
- Map tiles are **not redistributed as part of the code**, but are loaded at runtime from CARTO servers
51+
- Attribution is automatically displayed in the UI (see `web/static/js/app.js`)
52+
- CARTO Basemaps uses OpenStreetMap data and provides it as a free tile service
53+
- **Terms of Service:** CARTO's specific "Basemaps Terms of Service" should be reviewed directly: https://carto.com/legal
54+
- Since this is an external service called at runtime, it does **not** prevent redistribution of the NetFlowMap code under an open-source license
5555

56-
### Schriftarten
56+
### Fonts
5757

58-
| Komponente | Version | Quelle | Lizenz | Verwendung |
59-
|------------|---------|--------|--------|------------|
60-
| **JetBrains Mono** | - | https://fonts.google.com/specimen/JetBrains+Mono | SIL Open Font License 1.1 | Monospace-Schriftart für technische Informationen |
61-
| **Space Grotesk** | - | https://fonts.google.com/specimen/Space+Grotesk | SIL Open Font License 1.1 | Hauptschriftart für UI-Elemente |
58+
| Component | Version | Source | License | Usage |
59+
|-----------|---------|--------|---------|-------|
60+
| **JetBrains Mono** | - | https://fonts.google.com/specimen/JetBrains+Mono | SIL Open Font License 1.1 | Monospace font for technical information |
61+
| **Space Grotesk** | - | https://fonts.google.com/specimen/Space+Grotesk | SIL Open Font License 1.1 | Main font for UI elements |
6262

63-
**Hinweis:** Die Schriftarten werden über Google Fonts CDN geladen.
63+
**Note:** Fonts are loaded via Google Fonts CDN.
6464

65-
## Datenbanken & Datenquellen
65+
## Databases & Data Sources
6666

67-
| Komponente | Version | Quelle | Lizenz | Verwendung |
68-
|------------|---------|--------|--------|------------|
69-
| **DB-IP Lite City** | Monatlich aktualisiert | https://db-ip.com/db/lite.php | Creative Commons Attribution 4.0 International (CC BY 4.0) | GeoIP-Standortdatenbank (Stadt, Land, Koordinaten) |
70-
| **DB-IP Lite ASN** | Monatlich aktualisiert | https://db-ip.com/db/lite.php | Creative Commons Attribution 4.0 International (CC BY 4.0) | ASN-Datenbank (Autonomous System Number, Organisation) |
67+
| Component | Version | Source | License | Usage |
68+
|-----------|---------|--------|---------|-------|
69+
| **DB-IP Lite City** | Updated monthly | https://db-ip.com/db/lite.php | Creative Commons Attribution 4.0 International (CC BY 4.0) | GeoIP location database (city, country, coordinates) |
70+
| **DB-IP Lite ASN** | Updated monthly | https://db-ip.com/db/lite.php | Creative Commons Attribution 4.0 International (CC BY 4.0) | ASN database (Autonomous System Number, organization) |
7171

72-
**Hinweis:** Beide Datenbanken werden automatisch von NetFlowMap heruntergeladen und monatlich aktualisiert. Die Datenbanken werden im MaxMind DB Format bereitgestellt.
72+
**Note:** Both databases are automatically downloaded by NetFlowMap and updated monthly. The databases are provided in MaxMind DB format.
7373

74-
## Build-Tools & Runtime
74+
## Build Tools & Runtime
7575

76-
| Komponente | Version | Quelle | Lizenz | Verwendung |
77-
|------------|---------|--------|--------|------------|
78-
| **Alpine Linux** | 3.19 | https://alpinelinux.org/ | Apache License 2.0 | Basis-Image für Docker-Container |
79-
| **golang:1.25-alpine** | - | https://hub.docker.com/_/golang | BSD 3-Clause License (Go) | Build-Container für Docker-Builds |
76+
| Component | Version | Source | License | Usage |
77+
|-----------|---------|--------|---------|-------|
78+
| **Alpine Linux** | 3.19 | https://alpinelinux.org/ | Apache License 2.0 | Base image for Docker container |
79+
| **golang:1.25-alpine** | - | https://hub.docker.com/_/golang | BSD 3-Clause License (Go) | Build container for Docker builds |
8080

81-
## Lizenz-Kompatibilität
81+
## License Compatibility
8282

83-
Alle verwendeten Lizenzen sind kompatibel mit der MIT-Lizenz von NetFlowMap:
83+
All licenses used are compatible with NetFlowMap's MIT License:
8484

85-
- **MIT License**: Mehrere Komponenten (go-chi, golang-jwt/jwt, go-jose)
86-
- **Apache License 2.0**: Mehrere Komponenten (go-oidc, maxminddb-golang, yaml.v3, Alpine Linux)
87-
- **BSD 2-Clause / BSD 3-Clause**: Go-Standard-Bibliotheken und Leaflet
88-
- **SIL Open Font License 1.1**: Schriftarten (kompatibel mit MIT)
89-
- **Creative Commons Attribution 4.0**: GeoIP-Datenbanken (CC BY 4.0 erfordert Attribution)
90-
- **Open Database License (ODbL)**: OpenStreetMap-Daten (über CARTO Basemaps)
91-
- **CARTO Basemaps**: Externer Service, keine Code-Weiterverbreitung erforderlich
85+
- **MIT License**: Multiple components (go-chi, golang-jwt/jwt, go-jose)
86+
- **Apache License 2.0**: Multiple components (go-oidc, maxminddb-golang, yaml.v3, Alpine Linux)
87+
- **BSD 2-Clause / BSD 3-Clause**: Go standard libraries and Leaflet
88+
- **SIL Open Font License 1.1**: Fonts (compatible with MIT)
89+
- **Creative Commons Attribution 4.0**: GeoIP databases (CC BY 4.0 requires attribution)
90+
- **Open Database License (ODbL)**: OpenStreetMap data (via CARTO Basemaps)
91+
- **CARTO Basemaps**: External service, no code redistribution required
9292

93-
**Wichtig:** CARTO Basemaps ist ein externer Service, der zur Laufzeit aufgerufen wird. Die Karten-Tiles werden nicht als Teil des Codes weiterverbreitet, daher verhindern die CARTO Terms of Service **nicht** die Weiterverbreitung des NetFlowMap-Codes unter einer Open-Source-Lizenz. Die Nutzungsbedingungen gelten für die Nutzung des Services zur Laufzeit, nicht für die Verteilung des Codes.
93+
**Important:** CARTO Basemaps is an external service called at runtime. Map tiles are not redistributed as part of the code, therefore CARTO's Terms of Service do **not** prevent redistribution of the NetFlowMap code under an open-source license. The terms of service apply to using the service at runtime, not to code distribution.
9494

95-
## Attribution-Anforderungen
95+
## Attribution Requirements
9696

9797
### CC BY 4.0 (DB-IP Lite)
98-
Die GeoIP-Datenbanken von DB-IP Lite stehen unter CC BY 4.0 und erfordern Attribution. Diese erfolgt implizit durch die Verwendung der Datenbanken im Projekt.
98+
The GeoIP databases from DB-IP Lite are licensed under CC BY 4.0 and require attribution. This is implicitly provided through the use of the databases in the project.
9999

100-
### OpenStreetMap (über CARTO Basemaps)
101-
Die Attribution für OpenStreetMap und CARTO erfolgt automatisch im UI der Karte (siehe `web/templates/index.html`).
100+
### OpenStreetMap (via CARTO Basemaps)
101+
Attribution for OpenStreetMap and CARTO is automatically displayed in the map UI (see `web/templates/index.html`).
102102

103-
## Weitere Informationen
103+
## Further Information
104104

105-
- **NetFlowMap Lizenz**: MIT License (siehe LICENSE-Datei)
106-
- **Projekt-Repository**: https://github.com/kai/netflowmap
105+
- **NetFlowMap License**: MIT License (see LICENSE file)
106+
- **Project Repository**: https://github.com/RiskIdent/NetFlowMap
107107

108108
---
109109

110-
*Letzte Aktualisierung: 2025-01-27*
111-
110+
*Last updated: 2026-01-12*

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A real-time NetFlow visualization tool that displays network traffic on an inter
3232

3333
1. **Clone the repository**
3434
```bash
35-
git clone https://github.com/yourusername/NetFlowMap.git
35+
git clone https://github.com/RiskIdent/NetFlowMap.git
3636
cd NetFlowMap
3737
```
3838

@@ -82,7 +82,7 @@ ports:
8282
8383
1. **Clone the repository**
8484
```bash
85-
git clone https://github.com/yourusername/NetFlowMap.git
85+
git clone https://github.com/RiskIdent/NetFlowMap.git
8686
cd NetFlowMap
8787
```
8888

‎docs/screenshot.png‎

659 KB
Loading

0 commit comments

Comments
 (0)