[Script request]: nebula-sync

[tejasthakur123]

Application Name

nebula-sync

Website

https://github.com/lovelaze/nebula-sync

Description

Nebula sync is use to sync configuration between two pihole to achive HA
https://github.com/lovelaze/nebula-sync

Due Diligence

• I have searched existing scripts and found no duplicates.
• I have searched existing discussions and found no duplicate requests.

[martymarty004]

Since nebula-sync directly provides a standalone binary, maybe it would be more practical to integrate it directly within the Pi-Hole container. (Personally, I installed it this way, running as a service only on the primary instance).

I would suggest adding a prompt in the installation script asking if this container is the primary one and if sync is needed, and then just ask for the basic parameters required:
N_REPLICAS, SYNC_FREQ, REPLICA1, PASSW1, ...

With those, build an ENV file (and save it somewhere like /etc/nebula-sync.env):

PRIMARY=http://${THIS_IP}|${PRIMARY_PASSW}
REPLICAS=http://${REPLICA1}|${PASSW1},http://${REPLICA2}|${PASSW2},...
FULL_SYNC=true
RUN_GRAVITY=true
CRON=${SYNC_FREQ}  # The user could write the CRON on his own or we could give out a few choices
TZ=${TIMEZONE}

We then download the latest binary, extract it (+ remove zip), make it executable, move it to /usr/local/bin/.

For execution, we can create a simple service /etc/systemd/system/nebula-sync.service:

[Unit]
Description=Pi-hole Nebula Sync
After=network.target

[Service]
EnvironmentFile=/etc/nebula-sync.env
ExecStart=/usr/local/bin/nebula-sync run --env-file /etc/nebula-sync.env
Restart=on-failure

[Install]
WantedBy=multi-user.target

and we just start it:

systemctl daemon-reload
systemctl enable nebula-sync
systemctl start nebula-sync

---

If the user wants to disable nebula-sync, he can rerun the script and choose No, then we:

1. Check if service is enabled/running (do nothing if it's not loaded)
2. systemctl stop nebula-sync
3. systemctl disable nebula-sync

---

During an update, we can blindly download the latest executable, or we can compare the latest GitHub release with the output of:

nebula-sync -v
nebula-sync version v0.11.1