diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/USAGE.md b/docs/USAGE.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/VISION_STATEMENT.md b/docs/VISION.md similarity index 100% rename from docs/VISION_STATEMENT.md rename to docs/VISION.md diff --git a/roles/backup-data-to-usb/README.md b/roles/backup-data-to-usb/README.md index cc58d76b..08fc2b11 100644 --- a/roles/backup-data-to-usb/README.md +++ b/roles/backup-data-to-usb/README.md @@ -1,17 +1,25 @@ -# backup-data-to-usb +# Automated USB Backup -This Ansible role automates the process of performing backups to a swappable USB device. +## Description + +This Ansible role automates data backups to a swappable USB device. It triggers the backup process automatically when the USB is mounted, allowing for customizable source and destination paths and integrating with systemd for reliable execution. + +## Overview + +Optimized for Archlinux, this role ensures that backups are performed consistently with minimal manual intervention. It leverages efficient synchronization methods and provides a seamless integration with systemd to manage the backup service. + +## Purpose + +The primary purpose of this role is to simplify the backup process for systems that rely on removable USB devices. It is designed to reduce the risk of data loss by automating backups, ensuring that data is safely and consistently synchronized whenever the device is connected. ## Features -- Automatically starts the backup process when mounted to a specific destination. -- Supports customization of the backup source path and destination. -- Provides a systemd service to run the backup script. - -## Author - -This role was created and is maintained by Kevin Veen-Birkenbach. +- **Automatic Trigger:** Initiates the backup process immediately upon USB mount. +- **Customizable Paths:** Easily configure the source directory and backup destination. +- **Systemd Integration:** Manages the backup process via a dedicated systemd service. +- **Efficient Synchronization:** Utilizes rsync with incremental backup strategies for optimal performance. +- **Optimized for Archlinux:** Tailored for Archlinux systems using the rolling release model. ## Credits -This software was created with the assistance of [OpenAI ChatGPT](https://chat.openai.com/share/a75ca771-d8a4-4b75-9912-c515ba371ae4). \ No newline at end of file +Developed and maintained by **Kevin Veen-Birkenbach**. Special thanks to [OpenAI ChatGPT](https://chat.openai.com/share/a75ca771-d8a4-4b75-9912-c515ba371ae4) for its assistance in developing this role. \ No newline at end of file diff --git a/roles/backup-data-to-usb/meta/main.yml b/roles/backup-data-to-usb/meta/main.yml index cd4891be..979d0d3c 100644 --- a/roles/backup-data-to-usb/meta/main.yml +++ b/roles/backup-data-to-usb/meta/main.yml @@ -1,4 +1,27 @@ --- +galaxy_info: + author: "Kevin Veen-Birkenbach" + description: "Automated backups to a swappable USB device." + license: "CyMaIS NonCommercial License (CNCL)" + license_url: "https://s.veen.world/cncl" + company: | + Kevin Veen-Birkenbach + Consulting & Coaching Solutions + https://www.veen.world + min_ansible_version: "2.9" + platforms: + - name: Archlinux + versions: + - rolling + galaxy_tags: + - backup + - usb + - systemd + - automation + - archlinux + repository: https://s.veen.world/cymais + issue_tracker_url: https://s.veen.world/cymaisissues + documentation: https://s.veen.world/cymais dependencies: - role: cleanup-backups-service - role: system-maintenance-lock