Optimized overall READMEs and backup-data-to-usb role

This commit is contained in:
Kevin Veen-Birkenbach 2025-03-14 11:21:51 +01:00
parent 2a33c6a6dc
commit 9c4aeff807
No known key found for this signature in database
GPG Key ID: 44D8F11FD62F878E
10 changed files with 41 additions and 10 deletions

0
docs/ARCHITECTURE.md Normal file
View File

0
docs/CHANGELOG.md Normal file
View File

0
docs/CONTRIBUTING.md Normal file
View File

0
docs/FAQ.md Normal file
View File

0
docs/INSTALLATION.md Normal file
View File

0
docs/SECURITY.md Normal file
View File

0
docs/USAGE.md Normal file
View File

View File

@ -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).
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.

View File

@ -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