diff --git a/README.md b/README.md index 94647ee..19e66cd 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,15 @@ The ecosystem consists of three main parts: * Define your repeaters in `clients.json`. * Run: `python3 app.py` +#### 🔑 Generating VAPID Keys (Push Notifications) +To enable Web Push Notifications, you must generate a unique VAPID key pair for your server. +1. Go to a free online generator like [vapidkeys.com](https://vapidkeys.com/). +2. Generate the keys. +3. Open your `config.json` and paste them in the `webpush` section: + * `vapid_public_key`: Your newly generated Public Key + * `vapid_private_key`: Your newly generated Private Key + * `vapid_claim_email`: A contact email formatted as `"mailto:your@email.com"` + #### 2. Agent Setup (Remote Nodes) The `system_monitor.py` must be installed on every node you wish to monitor. * *(Optional)* Install `RPi.GPIO` (`pip install RPi.GPIO` or `apt install python3-rpi.gpio`) if you plan to use the physical Hardware Reset feature. @@ -79,6 +88,15 @@ L'ecosistema si compone di tre parti principali: * Definisci i tuoi ripetitori nel file `clients.json`. * Avvia: `python3 app.py` +#### 🔑 Generare le chiavi VAPID (Notifiche Push) +Per abilitare le Notifiche Push, devi generare una coppia di chiavi VAPID univoca per il tuo server. +1. Vai su un generatore online gratuito come [vapidkeys.com](https://vapidkeys.com/). +2. Genera la coppia di chiavi. +3. Apri il tuo file `config.json` e incollale nella sezione `webpush`: + * `vapid_public_key`: La tua Chiave Pubblica appena generata + * `vapid_private_key`: La tua Chiave Privata appena generata + * `vapid_claim_email`: Un indirizzo di contatto formattato come `"mailto:tua@email.com"` + #### 2. Setup dell'Agente (Nodi Remoti) Il file `system_monitor.py` va installato su ogni nodo che vuoi monitorare. * *(Opzionale)* Installa `RPi.GPIO` (`pip install RPi.GPIO` o `apt install python3-rpi.gpio`) se intendi utilizzare la funzione di Reset Hardware fisico della scheda.