albertoxamin/nodeliad repository overview

⁠Nodeliad 🤖

Nodeliad è un bot Telegram realizzato in Node.js per monitorare i consumi della propria linea Iliad.

Il progetto è nato per via della mancanza di un'app ufficiale per iOS che costringe gli utenti a controllare i consumi dal PC o attraverso il sito sotto rete Iliad per evitare di dover effettuare il login.

⁠Features

• 💰 controllo del credito residuo
• ⏰ controllo della data di rinnovo
• 🇮🇹 controllo dei consumi effettuati in Italia
• 🌎 controllo dei consumi effettuati all'estero
• 💶 controllo costi extra in Italia
• 💵 controllo consumi e costi extra all'estero

⁠Lista dei comandi

• /info
• /consumi
• /consumiestero
• /costiextra
• /costiextraestero

⁠Installazione

Con solo una linea nel terminale:

docker run -it -e "TG_TOKEN=your_token" -e "TG_USERNAME=your_telegram_username" -e "ILIAD_USER=your_iliad_usr" -e "ILIAD_PASS=your_iliad_password" --name iliad-bot albertoxamin/nodeliad:latest

Altrimenti

1. Clonare il repository con git clone https://github.com/Nicuz/Nodeliad.git oppure cliccando sul bottone in alto a destra Clone or Download
2. Entrare nella directory di Nodeliad
3. Installare le dipendenze con npm install
4. Rinominare il file config.json.template in config.jsone modificarlo inserendo i propri dati di accesso al sito di Iliad, il token del vostro bot fornito da BotFather⁠ e il vostro nickname di Telegram senza la @ iniziale. Il nickname viene utilizzato per fare un controllo sull'utente che invia un comando, il bot fornirà i dettagli sulla linea solo all'utente col nickname specificato. Oppure impostare nel env le seguenti variabili: TG_TOKEN TG_USERNAME ILIAD_USER ILIAD_PASS
5. Avviare il bot con node bot.js

⁠Aggiornare il bot

Questa sezione è pensata per i meno pratici di git che quindi non conoscono tutti i suoi comandi e funzionalità. Ogni volta che una nuova versione del bot viene rilasciata, è possibile scaricare automaticamente i file che sono stati aggiornati entrando nella cartella in cui avete clonato il repo e lanciando il comando git pull. Il file config.json che avete creato rimarrà al suo posto senza subire cambiamenti e non perderete alcun tipo di configurazione.

Un metodo semplice ed efficace per aggiornare la lista delle dipendenze nel caso dovessero essere aggiunti o rimossi dei moduli consiste nell'eliminare la cartella node_modules e lanciare il comando npm install.

Terminato l'aggiornamento vi basterà riavviare il bot.

⁠PM2

Se volete gestire il bot tramite PM2⁠, dopo aver creato il file config.json eseguite il comando pm2 start pm2-ecosystem.config.js

⁠Docker container

Se volete usare Docker, dopo aver clonato il repository e modificato il config.json (o settato le variabili d'ambiente) effettuate una docker build:

docker build . -t nodeliad

Terminata la build avviate il bot:

docker run -it --name=nodeliad-bot nodeliad

⁠Avvio automatico con systemd

1. Lanciare il comando whereis node per trovare il binario di node, nel mio caso /usr/local/bin/node
2. sudo nano /etc/systemd/system/nodeliad.service e incollare il testo seguente avendo l'accortezza di modificare il path del binario di node e quello dello del bot.

Description=Nodeliad Bot
After=network.target

[Service]
Type=idle
ExecStart=/path/binario/node /path/nodeliad/bot.js

[Install]
WantedBy=multi-user.target

1. sudo systemctl daemon-reload
2. sudo systemctl enable nodeliad
3. sudo systemctl start nodeliad

Se tutto è stato configurato correttamente, lanciando il comando sudo systemctl status nodeliad vedrete che il servizio è in esecuzione 💪

⁠Changelog

Consultare CHANGELOG.md⁠