From e3ed622ade932c1294b4604cc2e09ce6737748c0 Mon Sep 17 00:00:00 2001 From: Robert Rapp Date: Thu, 15 Jan 2026 03:50:18 +0100 Subject: [PATCH] Add deploy notes and env explanation --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 339f689..a38b00a 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,23 @@ Die dafür vorgesehenen Labels sind: Bitte füge diese zu dem Service hinzu, bei welchem man die gewünschten Header möchte. +## Run/Deploy (kurz) + +1. `example.env` kopieren und als `.env` befüllen (mindestens `MAXMIND_LICENSE_KEY`). +2. Den Updater-Container starten und `OUT_DIR` als Volume mounten (z. B. `/data`). +3. Den ASN-Detection-Service so starten, dass er **denselben** `OUT_DIR` liest. +4. Traefik ForwardAuth aktivieren und `authResponseHeaders` durchreichen. +5. Nach dem ersten Update sollten `GeoLite2-ASN.mmdb` und `nren_asns.txt` im `OUT_DIR` liegen. + +## example.env (kurz erklärt) + +- `MAXMIND_LICENSE_KEY`: notwendig für den GeoLite2 Download. +- `PDB_API_KEY`: optional, reduziert PeeringDB Rate-Limits. +- `OUT_DIR`: gemeinsamer Datenpfad zwischen Updater und Detection-Service. +- `PDB_BASE`, `PDB_INFO_TYPE`, `PDB_LIMIT`: PeeringDB Filter. +- `HTTP_TIMEOUT`: Timeout pro HTTP-Request. +- `INTERVAL_SECONDS`: Update-Intervall (Standard 30 Tage). + ## Update-Strategie - monatliche Aktualisierung der ASN-Daten