npm-sync

Synchronise les enregistrements CNAME locaux de Pi-hole avec les hôtes configurés dans Nginx Proxy Manager (NPM).

Description

Ce script permet de maintenir à jour les enregistrements DNS locaux (CNAME) sur Pi-hole en fonction des hôtes présents dans Nginx Proxy Manager. Utile pour les environnements locaux où les sous-domaines pointent vers des domaines internes.

Prérequis

• Un serveur Pi-hole opérationnel
• Nginx Proxy Manager (NPM) avec au moins un hôte configuré
• Accès SSH entre les serveurs (clé SSH sans mot de passe recommandée)

Sur Debian/Ubuntu, installer le serveur SSH si nécessaire :

sudo apt update
sudo apt install -y openssh-server
sudo systemctl enable --now ssh

Note : pensez à authoriser une premiére connexion sans clé sur le serveur NPM, surtout si l,uitilisateur est root (editer /etc/ssh/sshd_config >> PermitRootLogin yes puis sudo systemctl restart sshd -- remettre PermitRootLogin prohibit-password pour n'utiliser que la clé ssh) Générer une clé SSH sur le serveur NPM et copier la clé publique vers Pi-hole :

# Sur le serveur pihole
ssh-keygen -t ed25519 -f ~/.ssh/id_pihole -N "" -C "pihole@$(hostname)"
ssh-copy-id -i ~/.ssh/id_npm.pub root@npm.local ##remplacer par l'IP de votre NPM

# Test depuis pihole
ssh -i ~/.ssh/id_npm root@npm.local

Installation

# Cloner le dépôt
git clone https://github.com/IMNotMax/npm-sync.git
cd npm-sync

# Lancer le script d'installation
sh install.sh

Le script install.sh copie le script npm-sync dans /usr/local/bin, crée un fichier d'environnement et positionne les permissions appropriées. Veuillez éditer le fichier .env_npm-sync et y renseigner toutes les informations nécessaires

Utilisation

Exécutez la commande suivante pour lancer la synchronisation manuellement :

npm-sync

Planifier l'exécution (crontab)

Pour exécuter npm-sync toutes les 15 minutes, ajoutez la ligne suivante à la crontab de l'utilisateur approprié (crontab -e) :

*/15 * * * * /usr/local/bin/npm-sync >> /var/log/npm-sync.log 2>&1

Le fichier /var/log/npm-sync.log contiendra les sorties et erreurs pour faciliter le diagnostic.

Configuration

Le fichier .env_npm-sync doit être mis à jour

PIHOLE_PASSWORD=your_pihole_password_here
Rensigner le mot de passe du serveur pihole (nécessaire pour obtenir les tokens afin de mettre à jour les Records DNS)

PIHOLE_HOST=http://your-pihole.local
l'URL de votre serveur Pihole

NPM_HOST=192.168.x.x # Replace with your NPM host IP
L'IP de votre serveur NPM

MIN_DOMAIN_COUNT=1
Si vous avez plusieurs domaines gérés dans votre NPM, cela permet de remonter la config NPM dans Pihole à partir d'une occurence de sub-domain.domain.tld. Si vous faites des tests avec un autre domaine (et possiblement un autre serveur DNS) augmentez cette valeur
ATTENTION, votre domaine principal peut être impacté

CLEANUP_ORPHANS=true # Set to true to remove orphaned domains from Pi-hole
Permet de supprimer le ou les derniers sub-domain d'un domain.tld dans pihole lorsque qu'il n'existent plus dans NPM

NPM_SSH_KEY_PATH=/home/$USER/.ssh/id_pihole # Replace with the path to your SSH key
Chemin de la clé SSH (le chemin est déterminé dans l'install en fonction de votre user : root ou non)

Contribution

Les contributions sont bienvenues : corrections, tests et améliorations. Ouvrez une issue ou une pull request sur le dépôt.

A Faire

• Traduire en anglais le reste de la documentation

Licence

Licence MIT