====== MagicMirror – Backup auf NAS ======

===== Ziel =====

Der MagicMirror-Ordner wird auf ein NAS gesichert.

Es gibt zwei Varianten:

  * **Manuelles Backup:** Start bei Bedarf per Befehl
  * **Automatisches Backup:** jeden Sonntag um 01:00 Uhr

Eigenschaften:

  * Backup als komprimiertes ''tar.gz''
  * ''node_modules'' werden nicht gesichert
  * SHA-256-Prüfsumme zur Integritätskontrolle
  * NAS muss tatsächlich erreichbar und gemountet sein
  * unvollständige Backups bleiben als ''_INCOMPLETE'' erhalten
  * automatische Backups: maximal **4 Stück**
  * Erfolg/Fehler wird über **ioBroker → Telegram** gemeldet

===== Verwendete Pfade =====


^ Funktion ^ Pfad / Ort ^
| Manuelles Backup-Script | ''/home/pi/bin/backup_magicmirror.sh'' |
| Wöchentliches Backup-Script | ''/home/pi/bin/backup_magicmirror_weekly.sh'' |
| ioBroker-Zugangsdaten | ''/home/pi/.config/magicmirror-backup/iobroker.conf'' |
| Backup-Logs | ''/home/pi/magicmirror-backup-logs/'' |
| systemd-Service | ''/etc/systemd/system/magicmirror-backup-weekly.service'' |
| systemd-Timer | ''/etc/systemd/system/magicmirror-backup-weekly.timer'' |
| NAS-Zugangsdaten | ''/etc/samba/credentials-nasbackup'' |
| NAS-Mount-Konfiguration | ''/etc/fstab'' |
| NAS-Mountpunkt | ''/mnt/nasbackup'' |
| Manuelle Backups | ''/mnt/nasbackup/Manuelle_Backups/'' |
| Automatische Backups | ''/mnt/nasbackup/Automatische_Backups/'' |
| ioBroker Telegram-Script | ''ioBroker → Skripte → JavaScript'' |
| ioBroker Backup-Datenpunkte | ''0_userdata.0.MagicMirror.Backup.*'' |


====== 1. NAS auf dem Raspberry Pi einbinden ======

===== Pakete installieren =====

<code bash>
sudo apt update
sudo apt install cifs-utils
</code>


===== Gruppe anlegen =====

<code bash>
sudo groupadd nasusers
sudo usermod -aG nasusers <PI_USER>
</code>

Danach neu anmelden oder neu starten.

UID und GID ermitteln:

<code bash>
id -u <PI_USER>
getent group nasusers
</code>


===== Mountpunkt anlegen =====

<code bash>
sudo mkdir -p /mnt/nasbackup
</code>


===== NAS-Zugangsdaten speichern =====

<code bash>
sudo mkdir -p /etc/samba
sudo nano /etc/samba/credentials-nasbackup
</code>

Inhalt:

<code>
username=<NAS_USER>
password=<NAS_PASSWORT>
</code>

Datei schützen:

<code bash>
sudo chown root:root /etc/samba/credentials-nasbackup
sudo chmod 600 /etc/samba/credentials-nasbackup
</code>


===== /etc/fstab =====

Vorher sichern:

<code bash>
sudo cp /etc/fstab /etc/fstab.backup
sudo nano /etc/fstab
</code>

Eintrag:

<code>
//<NAS_HOST>/<NAS_SHARE> /mnt/nasbackup cifs credentials=/etc/samba/credentials-nasbackup,vers=3.0,iocharset=utf8,uid=<UID>,gid=<GID>,file_mode=0660,dir_mode=0770,_netdev,nofail,x-systemd.automount,x-systemd.mount-timeout=10s 0 0
</code>

systemd neu laden:

<code bash>
sudo systemctl daemon-reload
sudo systemctl start mnt-nasbackup.automount
</code>

Status:

<code bash>
systemctl status mnt-nasbackup.automount --no-pager
</code>

Erwartet:

<code>
Active: active (waiting)
</code>


===== NAS testen =====

Mount auslösen:

<code bash>
ls -la /mnt/nasbackup
</code>

Prüfen:

<code bash>
findmnt /mnt/nasbackup
df -h /mnt/nasbackup
</code>

Schreibtest:

<code bash>
touch /mnt/nasbackup/test.txt
rm /mnt/nasbackup/test.txt
</code>


====== 2. Manuelles MagicMirror-Backup ======

Das manuelle Backup:

  * wird per Befehl gestartet
  * läuft danach im Hintergrund
  * erzeugt ein geprüftes TAR.GZ-Archiv
  * erzeugt zusätzlich eine SHA-256-Prüfsumme
  * sichert keine ''node_modules''
  * bricht ab, wenn das NAS nicht korrekt gemountet ist
  * meldet Erfolg oder Fehler über ioBroker / Telegram

Die ioBroker-Zugangsdaten werden aus

<code>
~/.config/magicmirror-backup/iobroker.conf
</code>

gelesen.


===== Script =====

Das Script liegt unter:

<code>
~/bin/backup_magicmirror.sh
</code>

Bearbeiten:

<code bash>
nano ~/bin/backup_magicmirror.sh
</code>

Das Script besitzt intern zwei wichtige Betriebsarten:

^ Modus ^ Verwendung ^
| ''--worker'' | erstellt ausschließlich das Backup; wird auch vom automatischen Weekly-Backup verwendet |
| ''--manual-worker'' | führt den Backup-Worker aus und meldet anschließend Erfolg oder Fehler an ioBroker |

Dadurch erzeugt das automatische Backup keine doppelte Telegram-Nachricht.


===== Backup starten =====

<code bash>
~/bin/backup_magicmirror.sh
</code>

Das Backup läuft anschließend im Hintergrund.


===== Status / Log ansehen =====

<code bash>
tail -f "$(ls -t ~/magicmirror-backup-logs/*.log | head -1)"
</code>

Mit ''Ctrl+C'' wird nur die Log-Anzeige beendet.

Das Backup selbst läuft weiter.


===== Erfolgreiches Backup =====

Ein erfolgreiches Backup enthält:

<code>
MagicMirror.tar.gz
MagicMirror.tar.gz.sha256
</code>

Das Log enthält:

<code>
BACKUP ERFOLGREICH
</code>

Zusätzlich wird über ioBroker eine Telegram-Nachricht gesendet.


===== Speicherort =====

<code>
/mnt/nasbackup/Manuelle_Backups/
</code>

Beispiel:

<code>
MagicMirror_2026-10-08_21-30-00/
├── MagicMirror.tar.gz
└── MagicMirror.tar.gz.sha256
</code>


===== Backup prüfen =====

<code bash>
cd /mnt/nasbackup/Manuelle_Backups/MagicMirror_YYYY-MM-DD_HH-MM-SS

sha256sum -c MagicMirror.tar.gz.sha256
</code>

Erwartet:

<code>
MagicMirror.tar.gz: OK
</code>


====== 3. ioBroker für Backup-Meldungen ======

===== REST-API =====

In ioBroker den Adapter **REST API** installieren.

Empfohlene Einstellungen:

  * Authentifizierung: **Ein**
  * Keine GUI: **Ein**
  * Commands erlauben: **Aus**
  * Admin-Commands erlauben: **Aus**
  * API nur im internen Netzwerk erreichbar machen
  * kein Port-Forwarding ins Internet


===== Benutzer und Gruppe =====

ioBroker-Benutzer anlegen:

<code>
magicmirror
</code>

Gruppe anlegen:

<code>
magicmirror_backup
</code>

Benutzer der Gruppe hinzufügen.

Benötigte Gruppenrechte:

  * Objekte: Auflisten + Lesen
  * Zustände: Auflisten + Lesen + Schreiben
  * HTTP: Ein
  * Execute/SendTo: Aus


===== Datenpunkte =====

Folgende Datenpunkte werden benötigt:

<code>
0_userdata.0.MagicMirror.Backup.Status
0_userdata.0.MagicMirror.Backup.Message
0_userdata.0.MagicMirror.Backup.LastRun
0_userdata.0.MagicMirror.Backup.BackupPath
</code>

Wichtig:

Der Benutzer ''magicmirror'' sollte Besitzer dieser vier Datenpunkte sein.

Beispiel auf dem ioBroker-Host:

<code bash>
iobroker object chown magicmirror magicmirror_backup 0_userdata.0.MagicMirror.Backup.Status
iobroker object chown magicmirror magicmirror_backup 0_userdata.0.MagicMirror.Backup.Message
iobroker object chown magicmirror magicmirror_backup 0_userdata.0.MagicMirror.Backup.LastRun
iobroker object chown magicmirror magicmirror_backup 0_userdata.0.MagicMirror.Backup.BackupPath
</code>


===== Telegram-JavaScript =====

Im ioBroker-JavaScript-Adapter:

<code javascript>
const BASE = '0_userdata.0.MagicMirror.Backup';

createState(`${BASE}.Status`, 'idle', {
    type: 'string',
    role: 'text',
    read: true,
    write: true
});

createState(`${BASE}.Message`, '', {
    type: 'string',
    role: 'text',
    read: true,
    write: true
});

createState(`${BASE}.LastRun`, '', {
    type: 'string',
    role: 'text',
    read: true,
    write: true
});

createState(`${BASE}.BackupPath`, '', {
    type: 'string',
    role: 'text',
    read: true,
    write: true
});


on({
    id: `${BASE}.Status`,
    change: 'ne'
}, obj => {

    const status = String(obj.state.val);

    if (status !== 'success' && status !== 'error') return;

    const message = String(getState(`${BASE}.Message`).val || '');
    const lastRun = String(getState(`${BASE}.LastRun`).val || '');
    const backupPath = String(getState(`${BASE}.BackupPath`).val || '');

    let text;

    if (status === 'success') {
        text = `✅ MagicMirror Backup erfolgreich\n\n${message}`;
    } else {
        text = `❌ MagicMirror Backup FEHLGESCHLAGEN\n\n${message}`;
    }

    text += `\n\nZeit: ${lastRun}`;

    if (backupPath) {
        text += `\nBackup: ${backupPath}`;
    }

    sendTo('telegram.0', text);
});
</code>


====== 4. Zugangsdaten für ioBroker auf dem Pi ======

<code bash>
mkdir -p ~/.config/magicmirror-backup
nano ~/.config/magicmirror-backup/iobroker.conf
</code>

Inhalt:

<code bash>
IOBROKER_URL='http://<IOBROKER_HOST>:<REST_PORT>'
IOBROKER_USER='magicmirror'
IOBROKER_PASSWORD='<PASSWORT>'
</code>

Datei schützen:

<code bash>
chmod 600 ~/.config/magicmirror-backup/iobroker.conf
</code>


====== 5. Automatisches wöchentliches Backup ======

===== Script =====

<code bash>
nano ~/bin/backup_magicmirror_weekly.sh
</code>

Inhalt:

<code bash>
#!/usr/bin/env bash

BACKUP_SCRIPT="$HOME/bin/backup_magicmirror.sh"

NAS="/mnt/nasbackup"
AUTO_BASE="$NAS/Automatische_Backups"

LOGDIR="$HOME/magicmirror-backup-logs"

CONFIG="$HOME/.config/magicmirror-backup/iobroker.conf"

KEEP_BACKUPS=4

STATE_BASE="0_userdata.0.MagicMirror.Backup"


if [[ ! -r "$CONFIG" ]]; then
    echo "FEHLER: $CONFIG fehlt."
    exit 1
fi

source "$CONFIG"


set_iobroker_state() {

    local ID="$1"
    local VALUE="$2"

    curl \
        --fail \
        --silent \
        --show-error \
        --max-time 10 \
        --user "${IOBROKER_USER}:${IOBROKER_PASSWORD}" \
        --get \
        --data-urlencode "value=${VALUE}" \
        "${IOBROKER_URL}/v1/state/${ID}" \
        >/dev/null
}


notify_iobroker() {

    local STATUS="$1"
    local MESSAGE="$2"
    local BACKUP_PATH="${3:-}"

    set_iobroker_state "${STATE_BASE}.Message" "$MESSAGE" || return 1
    set_iobroker_state "${STATE_BASE}.BackupPath" "$BACKUP_PATH" || return 1
    set_iobroker_state "${STATE_BASE}.LastRun" "$(date -Iseconds)" || return 1

    # Status zuletzt setzen: dieser löst Telegram aus.
    set_iobroker_state "${STATE_BASE}.Status" "$STATUS"
}


mkdir -p "$LOGDIR"

STAMP="$(date '+%Y-%m-%d_%H-%M-%S')"

DEST="$AUTO_BASE/MagicMirror_Auto_$STAMP"

LOG="$LOGDIR/MagicMirror_Auto_$STAMP.log"


set_iobroker_state "${STATE_BASE}.Status" "running" || true


"$BACKUP_SCRIPT" --worker "$DEST" >"$LOG" 2>&1

RESULT=$?


if [[ $RESULT -eq 0 ]]; then

    SIZE="$(du -h "$DEST/MagicMirror.tar.gz" | awk '{print $1}')"

    mapfile -t BACKUPS < <(
        find "$AUTO_BASE" \
            -mindepth 1 \
            -maxdepth 1 \
            -type d \
            -name 'MagicMirror_Auto_*' \
            ! -name '*_INCOMPLETE' \
            -printf '%f\n' \
            | sort -r
    )

    if (( ${#BACKUPS[@]} > KEEP_BACKUPS )); then

        for ((i=KEEP_BACKUPS; i<${#BACKUPS[@]}; i++)); do
            rm -rf -- "$AUTO_BASE/${BACKUPS[$i]}"
        done

    fi


    MESSAGE="Automatisches MagicMirror-Backup erfolgreich. Größe: ${SIZE}. Es werden ${KEEP_BACKUPS} automatische Backups aufbewahrt."

    notify_iobroker "success" "$MESSAGE" "$DEST" || true

    exit 0
fi


MESSAGE="Automatisches MagicMirror-Backup fehlgeschlagen. Exit-Code: ${RESULT}. Log: ${LOG}"

notify_iobroker "error" "$MESSAGE" "${DEST}_INCOMPLETE" || true

exit "$RESULT"
</code>

Ausführbar machen:

<code bash>
chmod +x ~/bin/backup_magicmirror_weekly.sh
</code>

Manueller Test:

<code bash>
~/bin/backup_magicmirror_weekly.sh
</code>

Bei Erfolg:

  * Backup liegt unter ''Automatische_Backups''
  * Telegram-Meldung wird gesendet
  * Exit-Code ist ''0''


====== 6. systemd-Timer ======

===== Service =====

<code bash>
sudo nano /etc/systemd/system/magicmirror-backup-weekly.service
</code>

<code ini>
[Unit]
Description=Wöchentliches MagicMirror Backup auf NAS
Wants=network-online.target
After=network-online.target

[Service]
Type=oneshot
User=<PI_USER>
Group=<PI_USER>
Environment=HOME=/home/<PI_USER>
WorkingDirectory=/home/<PI_USER>

ExecStart=/home/<PI_USER>/bin/backup_magicmirror_weekly.sh

TimeoutStartSec=infinity
</code>


===== Timer =====

<code bash>
sudo nano /etc/systemd/system/magicmirror-backup-weekly.timer
</code>

<code ini>
[Unit]
Description=MagicMirror Backup jeden Sonntag um 01:00 Uhr

[Timer]
OnCalendar=Sun *-*-* 01:00:00
Persistent=true
AccuracySec=1min

[Install]
WantedBy=timers.target
</code>


===== Aktivieren =====

<code bash>
sudo systemctl daemon-reload
sudo systemctl enable --now magicmirror-backup-weekly.timer
</code>

Kontrolle:

<code bash>
systemctl list-timers --all | grep magicmirror
</code>

Timer-Status:

<code bash>
systemctl status magicmirror-backup-weekly.timer --no-pager
</code>

Erwartet:

<code>
Active: active (waiting)
</code>


===== Service manuell testen =====

<code bash>
sudo systemctl start magicmirror-backup-weekly.service
</code>

Danach:

<code bash>
systemctl status magicmirror-backup-weekly.service --no-pager
</code>


====== 7. Backups prüfen ======

===== SHA-256 =====

<code bash>
cd /mnt/nasbackup/Manuelle_Backups/MagicMirror_YYYY-MM-DD_HH-MM-SS
sha256sum -c MagicMirror.tar.gz.sha256
</code>

Erwartet:

<code>
MagicMirror.tar.gz: OK
</code>


===== Archivinhalt ansehen =====

<code bash>
tar -tzf MagicMirror.tar.gz | less
</code>


====== 8. Wiederherstellung ======

===== Auf gleichem System =====

Archiv prüfen:

<code bash>
sha256sum -c MagicMirror.tar.gz.sha256
</code>

Dann:

<code bash>
tar -xzf MagicMirror.tar.gz -C ~
</code>


===== Auf einem neuen Raspberry Pi =====

Bei einem neuen Pi sollte MagicMirror und Node.js zunächst frisch installiert werden.

Aus dem Backup werden anschließend insbesondere übernommen:

  * ''config/config.js''
  * ''css/custom.css''
  * Drittmodule und deren Konfiguration
  * eigene Bilder, Skripte und Dateien

''node_modules'' werden bewusst nicht wiederhergestellt.

Die Abhängigkeiten werden auf dem neuen System neu installiert.


====== 9. Alltag ======

===== Manuelles Backup starten =====

<code bash>
~/bin/backup_magicmirror.sh
</code>

Bei Erfolg oder Fehler wird automatisch eine Telegram-Nachricht über ioBroker gesendet.


===== Aktuelles Backup-Log =====

<code bash>
tail -f "$(ls -t ~/magicmirror-backup-logs/*.log | head -1)"
</code>


===== Automatisches Backup =====

Das automatische Backup läuft:

<code>
jeden Sonntag um 01:00 Uhr
</code>

Es werden maximal:

<code>
4 automatische Backups
</code>

aufbewahrt.

Manuelle Backups werden dadurch nicht gelöscht.


===== Timer prüfen =====

<code bash>
systemctl list-timers --all | grep magicmirror
</code>


===== NAS prüfen =====

<code bash>
findmnt /mnt/nasbackup
df -h /mnt/nasbackup
</code>


===== Backup prüfen =====

Im jeweiligen Backup-Verzeichnis:

<code bash>
sha256sum -c MagicMirror.tar.gz.sha256
</code>

Erwartet:

<code>
MagicMirror.tar.gz: OK
</code>