diff --git a/00_README.md b/00_README.md deleted file mode 100644 index dcc3311..0000000 --- a/00_README.md +++ /dev/null @@ -1,203 +0,0 @@ -# README – Snapshot-Backup mit rsync - -Dieses Skript erstellt Snapshots des Home-Verzeichnisses mit `rsync` und `--link-dest`.[cite:43][cite:34] Jeder Snapshot sieht wie ein vollständiges Backup aus, aber unveränderte Dateien werden per Hardlink wiederverwendet, sodass Speicherplatz gespart wird.[cite:34][cite:92] - -## Zweck - -Das Skript sichert den Inhalt von `HOME` auf ein externes Zielverzeichnis und legt dabei zeitgestempelte Snapshot-Ordner an.[cite:43] Über den Symlink `latest` wird immer auf den zuletzt erfolgreichen Sicherungsstand verwiesen.[cite:34][cite:92] - -Typische Vorteile dieses Ansatzes: - -- Einfach browsebare Backups, weil jeder Snapshot als normales Verzeichnis vorliegt.[cite:43][cite:91] -- Platzersparnis durch Hardlinks mit `--link-dest`.[cite:34][cite:92] -- Aufbewahrung mehrerer Sicherungsstände durch Rotation älterer Snapshots.[cite:43] - -## Voraussetzungen - -Für `--link-dest` sollte das Ziel auf einem Linux-Dateisystem liegen, das Hardlinks sauber unterstützt, etwa ext4, XFS oder btrfs.[cite:34][cite:91] Dateisysteme wie exFAT sind für diese Snapshot-Technik ungeeignet.[cite:34] - -Benötigte Werkzeuge: - -- `bash` -- `rsync` -- `readlink` -- `tee` -- Standard-Tools wie `mkdir`, `ln`, `ls`, `tail`, `rm` - -## Verzeichnisaufbau - -Das Skript erzeugt pro Lauf einen neuen Snapshot mit Zeitstempel.[cite:43][cite:92] - -Beispiel: - -```text -/run/media/hans/usbsicherung/jacboy_sicherung/ -└── / - ├── 2026-04-28_10-30-00/ - ├── 2026-04-29_10-30-00/ - ├── latest -> /run/media/hans/usbsicherung/jacboy_sicherung//2026-04-29_10-30-00 - └── logs/ -``` - -## Funktionsweise - -Das Skript prüft zunächst, ob das Zielverzeichnis existiert und beschreibbar ist, und legt anschließend Snapshot- und Log-Verzeichnisse an.[cite:43][cite:97] Danach wird `rsync` mit Archivoptionen sowie Ausschlüssen für nicht benötigte Verzeichnisse ausgeführt.[cite:43][cite:91] - -Wenn bereits ein gültiger vorheriger Snapshot existiert, wird dieser über `--link-dest` als Referenz verwendet.[cite:34][cite:92] Unveränderte Dateien werden dann nicht erneut kopiert, sondern als Hardlinks im neuen Snapshot eingebunden.[cite:34] - -Nach erfolgreichem Lauf aktualisiert das Skript den Symlink `latest` und entfernt ältere Snapshots oberhalb des konfigurierten Aufbewahrungswerts `KEEP`.[cite:43] - -## Verwendete rsync-Optionen - -| Option | Bedeutung | -|---|---| -| `-a` | Archivmodus: rekursiv kopieren und Metadaten erhalten.[cite:91][cite:43] | -| `-H` | Hardlinks in der Quelle erhalten.[cite:91] | -| `-A` | ACLs mitnehmen, sofern vorhanden.[cite:91] | -| `-X` | Erweiterte Attribute mitnehmen.[cite:91] | -| `-x` | Auf demselben Dateisystem bleiben; zusätzliche Mounts unterhalb von `HOME` werden nicht traversiert.[cite:91][cite:43] | -| `--delete` | Entfernt Dateien im neuen Snapshot, die in der Quelle nicht mehr vorhanden sind; ältere Snapshots bleiben dabei unberührt.[cite:91][cite:34] | -| `--delete-excluded` | Entfernt auch explizit ausgeschlossene Inhalte aus dem Ziel-Snapshot.[cite:91] | -| `--link-dest` | Verweist auf den letzten Snapshot, damit unveränderte Dateien per Hardlink wiederverwendet werden.[cite:34][cite:92] | - -## Anpassbare Variablen - -Die wichtigsten Variablen stehen am Anfang des Skripts: - -```bash -SRC="${HOME}/" -DEST_BASE="/run/media/hans/usbsicherung/jacboy_sicherung" -KEEP=30 -``` - -- `SRC`: Quellverzeichnis, standardmäßig das eigene Home-Verzeichnis. -- `DEST_BASE`: Basisverzeichnis auf dem Backup-Medium. -- `KEEP`: Anzahl der Snapshots, die aufbewahrt werden sollen. - -Auch die Ausschlussliste kann direkt im Array `EXCLUDES` angepasst werden, zum Beispiel für Cache-, Download- oder temporäre Verzeichnisse.[cite:43] - -## Verwendung - -Syntax prüfen: - -```bash -bash -n sicherung.sh -``` - -Skript ausführen: - -```bash -bash sicherung.sh -``` - -Für einen sicheren Test kann vorübergehend `--dry-run` in die `RSYNC_OPTS` aufgenommen werden; dann zeigt `rsync` nur an, was passieren würde, ohne tatsächlich Daten zu schreiben.[cite:91][cite:43] - -## Beispielskript - -```bash -#!/usr/bin/env bash -set -Eeuo pipefail - -SRC="${HOME}/" -DEST_BASE="/run/media/hans/usbsicherung/jacboy_sicherung" -HOST="$(hostname -s)" -STAMP="$(date +%F_%H-%M-%S)" -SNAPSHOT_DIR="${DEST_BASE}/${HOST}/${STAMP}" -LAST_LINK="${DEST_BASE}/${HOST}/latest" -LOG_DIR="${DEST_BASE}/${HOST}/logs" -LOG_FILE="${LOG_DIR}/backup-${STAMP}.log" -KEEP=30 - -log() { - local msg="[$(date +%F\ %T)] $*" - echo "${msg}" - if [[ -n "${LOG_FILE:-}" ]]; then - mkdir -p "$(dirname "${LOG_FILE}")" - echo "${msg}" >> "${LOG_FILE}" - fi -} - -fail() { - log "FEHLER: $*" - exit 1 -} - -if [[ ! -d "${DEST_BASE}" ]]; then - fail "Zielbasis ${DEST_BASE} existiert nicht oder ist nicht gemountet. Bitte USB-Laufwerk prüfen." -fi - -if [[ ! -w "${DEST_BASE}" ]]; then - fail "Zielbasis ${DEST_BASE} ist nicht beschreibbar. Rechte/Mount prüfen." -fi - -mkdir -p "${SNAPSHOT_DIR}" "${LOG_DIR}" - -log "Starte Backup: ${SRC} -> ${SNAPSHOT_DIR}" - -RSYNC_OPTS=( - -aHAXx - --numeric-ids - --delete - --delete-excluded - --info=stats2,progress2 - --human-readable - --partial -) - -EXCLUDES=( - --exclude=".cache/" - --exclude="Downloads/" - --exclude=".local/share/Trash/" - --exclude=".gvfs/" - --exclude=".dotnet/" - --exclude=".codegpt/" - --exclude=".copilot/" - --exclude=".var/" - --exclude=".vscode/" - --exclude="temp/" -) - -if [[ -L "${LAST_LINK}" ]] && [[ -d "$(readlink -f "${LAST_LINK}")" ]]; then - RSYNC_OPTS+=(--link-dest="$(readlink -f "${LAST_LINK}")") - log "Verwende link-dest: $(readlink -f "${LAST_LINK}")" -else - log "Kein gültiger letzter Snapshot gefunden – es wird ein vollständiger Lauf erstellt." -fi - -if rsync "${RSYNC_OPTS[@]}" \ - "${EXCLUDES[@]}" \ - "${SRC}" "${SNAPSHOT_DIR}/" | tee -a "${LOG_FILE}" -then - log "rsync erfolgreich abgeschlossen." -else - fail "rsync ist mit einem Fehler beendet worden." -fi - -ln -sfn "${SNAPSHOT_DIR}" "${LAST_LINK}" -log "latest-Link zeigt jetzt auf ${SNAPSHOT_DIR}" - -cd "${DEST_BASE}/${HOST}" -SNAPS=(20*/) - -if (( ${#SNAPS[@]} > KEEP )); then - log "Rotationslauf: Es existieren ${#SNAPS[@]} Snapshots, KEEP=${KEEP}." - ls -1dt 20*/ | tail -n +$((KEEP + 1)) | while read -r old; do - log "Lösche alten Snapshot: ${old}" - rm -rf -- "${old}" - done -else - log "Rotationslauf: Es müssen keine alten Snapshots gelöscht werden (Anzahl: ${#SNAPS[@]}, KEEP=${KEEP})." -fi - -log "Backup abgeschlossen." -``` - -## Sicherheitshinweise - -Ein erster Testlauf sollte als Dry-Run erfolgen, um Ausschlüsse, Zielpfad und Verhalten zu prüfen, bevor echte Daten geschrieben oder gelöscht werden.[cite:91][cite:43] Das Zielverzeichnis sollte nicht innerhalb des zu sichernden Home-Verzeichnisses liegen, um Rekursionen und ungewollte Mitsicherungen zu vermeiden.[cite:43] - -Bei Verwendung von `--delete` gilt: Gelöschte Dateien verschwinden aus dem neu erzeugten Snapshot, bleiben aber in älteren Snapshots weiterhin vorhanden.[cite:34][cite:92] Genau dadurch entsteht die gewünschte Snapshot-Historie.[cite:92] - -## Mögliche Erweiterungen - -Sinnvolle nächste Ausbaustufen wären ein optionaler `--dry-run`-Schalter, eine Prüfung des tatsächlichen Mountpoints per `mountpoint`, sowie eine Automatisierung über `systemd`-Timer statt manueller Ausführung.[cite:97][cite:43] diff --git a/README.md b/README.md index eb418cf..dcc3311 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,203 @@ -# datensicherung_rsync +# README – Snapshot-Backup mit rsync +Dieses Skript erstellt Snapshots des Home-Verzeichnisses mit `rsync` und `--link-dest`.[cite:43][cite:34] Jeder Snapshot sieht wie ein vollständiges Backup aus, aber unveränderte Dateien werden per Hardlink wiederverwendet, sodass Speicherplatz gespart wird.[cite:34][cite:92] +## Zweck -## Getting started +Das Skript sichert den Inhalt von `HOME` auf ein externes Zielverzeichnis und legt dabei zeitgestempelte Snapshot-Ordner an.[cite:43] Über den Symlink `latest` wird immer auf den zuletzt erfolgreichen Sicherungsstand verwiesen.[cite:34][cite:92] -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +Typische Vorteile dieses Ansatzes: -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +- Einfach browsebare Backups, weil jeder Snapshot als normales Verzeichnis vorliegt.[cite:43][cite:91] +- Platzersparnis durch Hardlinks mit `--link-dest`.[cite:34][cite:92] +- Aufbewahrung mehrerer Sicherungsstände durch Rotation älterer Snapshots.[cite:43] -## Add your files +## Voraussetzungen -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command: +Für `--link-dest` sollte das Ziel auf einem Linux-Dateisystem liegen, das Hardlinks sauber unterstützt, etwa ext4, XFS oder btrfs.[cite:34][cite:91] Dateisysteme wie exFAT sind für diese Snapshot-Technik ungeeignet.[cite:34] -``` -cd existing_repo -git remote add origin https://code.lonely-wolf.at/hans/datensicherung_rsync.git -git branch -M main -git push -uf origin main +Benötigte Werkzeuge: + +- `bash` +- `rsync` +- `readlink` +- `tee` +- Standard-Tools wie `mkdir`, `ln`, `ls`, `tail`, `rm` + +## Verzeichnisaufbau + +Das Skript erzeugt pro Lauf einen neuen Snapshot mit Zeitstempel.[cite:43][cite:92] + +Beispiel: + +```text +/run/media/hans/usbsicherung/jacboy_sicherung/ +└── / + ├── 2026-04-28_10-30-00/ + ├── 2026-04-29_10-30-00/ + ├── latest -> /run/media/hans/usbsicherung/jacboy_sicherung//2026-04-29_10-30-00 + └── logs/ ``` -## Integrate with your tools +## Funktionsweise -- [ ] [Set up project integrations](https://code.lonely-wolf.at/hans/datensicherung_rsync/-/settings/integrations) +Das Skript prüft zunächst, ob das Zielverzeichnis existiert und beschreibbar ist, und legt anschließend Snapshot- und Log-Verzeichnisse an.[cite:43][cite:97] Danach wird `rsync` mit Archivoptionen sowie Ausschlüssen für nicht benötigte Verzeichnisse ausgeführt.[cite:43][cite:91] -## Collaborate with your team +Wenn bereits ein gültiger vorheriger Snapshot existiert, wird dieser über `--link-dest` als Referenz verwendet.[cite:34][cite:92] Unveränderte Dateien werden dann nicht erneut kopiert, sondern als Hardlinks im neuen Snapshot eingebunden.[cite:34] -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/) +Nach erfolgreichem Lauf aktualisiert das Skript den Symlink `latest` und entfernt ältere Snapshots oberhalb des konfigurierten Aufbewahrungswerts `KEEP`.[cite:43] -## Test and Deploy +## Verwendete rsync-Optionen -Use the built-in continuous integration in GitLab. +| Option | Bedeutung | +|---|---| +| `-a` | Archivmodus: rekursiv kopieren und Metadaten erhalten.[cite:91][cite:43] | +| `-H` | Hardlinks in der Quelle erhalten.[cite:91] | +| `-A` | ACLs mitnehmen, sofern vorhanden.[cite:91] | +| `-X` | Erweiterte Attribute mitnehmen.[cite:91] | +| `-x` | Auf demselben Dateisystem bleiben; zusätzliche Mounts unterhalb von `HOME` werden nicht traversiert.[cite:91][cite:43] | +| `--delete` | Entfernt Dateien im neuen Snapshot, die in der Quelle nicht mehr vorhanden sind; ältere Snapshots bleiben dabei unberührt.[cite:91][cite:34] | +| `--delete-excluded` | Entfernt auch explizit ausgeschlossene Inhalte aus dem Ziel-Snapshot.[cite:91] | +| `--link-dest` | Verweist auf den letzten Snapshot, damit unveränderte Dateien per Hardlink wiederverwendet werden.[cite:34][cite:92] | -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +## Anpassbare Variablen -*** +Die wichtigsten Variablen stehen am Anfang des Skripts: -# Editing this README +```bash +SRC="${HOME}/" +DEST_BASE="/run/media/hans/usbsicherung/jacboy_sicherung" +KEEP=30 +``` -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +- `SRC`: Quellverzeichnis, standardmäßig das eigene Home-Verzeichnis. +- `DEST_BASE`: Basisverzeichnis auf dem Backup-Medium. +- `KEEP`: Anzahl der Snapshots, die aufbewahrt werden sollen. -## Suggestions for a good README +Auch die Ausschlussliste kann direkt im Array `EXCLUDES` angepasst werden, zum Beispiel für Cache-, Download- oder temporäre Verzeichnisse.[cite:43] -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +## Verwendung -## Name -Choose a self-explaining name for your project. +Syntax prüfen: -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +```bash +bash -n sicherung.sh +``` -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +Skript ausführen: -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +```bash +bash sicherung.sh +``` -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +Für einen sicheren Test kann vorübergehend `--dry-run` in die `RSYNC_OPTS` aufgenommen werden; dann zeigt `rsync` nur an, was passieren würde, ohne tatsächlich Daten zu schreiben.[cite:91][cite:43] -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +## Beispielskript -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +```bash +#!/usr/bin/env bash +set -Eeuo pipefail -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +SRC="${HOME}/" +DEST_BASE="/run/media/hans/usbsicherung/jacboy_sicherung" +HOST="$(hostname -s)" +STAMP="$(date +%F_%H-%M-%S)" +SNAPSHOT_DIR="${DEST_BASE}/${HOST}/${STAMP}" +LAST_LINK="${DEST_BASE}/${HOST}/latest" +LOG_DIR="${DEST_BASE}/${HOST}/logs" +LOG_FILE="${LOG_DIR}/backup-${STAMP}.log" +KEEP=30 -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +log() { + local msg="[$(date +%F\ %T)] $*" + echo "${msg}" + if [[ -n "${LOG_FILE:-}" ]]; then + mkdir -p "$(dirname "${LOG_FILE}")" + echo "${msg}" >> "${LOG_FILE}" + fi +} -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +fail() { + log "FEHLER: $*" + exit 1 +} -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +if [[ ! -d "${DEST_BASE}" ]]; then + fail "Zielbasis ${DEST_BASE} existiert nicht oder ist nicht gemountet. Bitte USB-Laufwerk prüfen." +fi -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +if [[ ! -w "${DEST_BASE}" ]]; then + fail "Zielbasis ${DEST_BASE} ist nicht beschreibbar. Rechte/Mount prüfen." +fi -## License -For open source projects, say how it is licensed. +mkdir -p "${SNAPSHOT_DIR}" "${LOG_DIR}" -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +log "Starte Backup: ${SRC} -> ${SNAPSHOT_DIR}" + +RSYNC_OPTS=( + -aHAXx + --numeric-ids + --delete + --delete-excluded + --info=stats2,progress2 + --human-readable + --partial +) + +EXCLUDES=( + --exclude=".cache/" + --exclude="Downloads/" + --exclude=".local/share/Trash/" + --exclude=".gvfs/" + --exclude=".dotnet/" + --exclude=".codegpt/" + --exclude=".copilot/" + --exclude=".var/" + --exclude=".vscode/" + --exclude="temp/" +) + +if [[ -L "${LAST_LINK}" ]] && [[ -d "$(readlink -f "${LAST_LINK}")" ]]; then + RSYNC_OPTS+=(--link-dest="$(readlink -f "${LAST_LINK}")") + log "Verwende link-dest: $(readlink -f "${LAST_LINK}")" +else + log "Kein gültiger letzter Snapshot gefunden – es wird ein vollständiger Lauf erstellt." +fi + +if rsync "${RSYNC_OPTS[@]}" \ + "${EXCLUDES[@]}" \ + "${SRC}" "${SNAPSHOT_DIR}/" | tee -a "${LOG_FILE}" +then + log "rsync erfolgreich abgeschlossen." +else + fail "rsync ist mit einem Fehler beendet worden." +fi + +ln -sfn "${SNAPSHOT_DIR}" "${LAST_LINK}" +log "latest-Link zeigt jetzt auf ${SNAPSHOT_DIR}" + +cd "${DEST_BASE}/${HOST}" +SNAPS=(20*/) + +if (( ${#SNAPS[@]} > KEEP )); then + log "Rotationslauf: Es existieren ${#SNAPS[@]} Snapshots, KEEP=${KEEP}." + ls -1dt 20*/ | tail -n +$((KEEP + 1)) | while read -r old; do + log "Lösche alten Snapshot: ${old}" + rm -rf -- "${old}" + done +else + log "Rotationslauf: Es müssen keine alten Snapshots gelöscht werden (Anzahl: ${#SNAPS[@]}, KEEP=${KEEP})." +fi + +log "Backup abgeschlossen." +``` + +## Sicherheitshinweise + +Ein erster Testlauf sollte als Dry-Run erfolgen, um Ausschlüsse, Zielpfad und Verhalten zu prüfen, bevor echte Daten geschrieben oder gelöscht werden.[cite:91][cite:43] Das Zielverzeichnis sollte nicht innerhalb des zu sichernden Home-Verzeichnisses liegen, um Rekursionen und ungewollte Mitsicherungen zu vermeiden.[cite:43] + +Bei Verwendung von `--delete` gilt: Gelöschte Dateien verschwinden aus dem neu erzeugten Snapshot, bleiben aber in älteren Snapshots weiterhin vorhanden.[cite:34][cite:92] Genau dadurch entsteht die gewünschte Snapshot-Historie.[cite:92] + +## Mögliche Erweiterungen + +Sinnvolle nächste Ausbaustufen wären ein optionaler `--dry-run`-Schalter, eine Prüfung des tatsächlichen Mountpoints per `mountpoint`, sowie eine Automatisierung über `systemd`-Timer statt manueller Ausführung.[cite:97][cite:43]