Refactored pc roles and added README.md's with help of ChatGPT. See https://chat.openai.com/share/df22ba6a-76d0-47c2-a8c7-daec3f42b4e5

This commit is contained in:
2023-12-02 18:49:50 +01:00
parent 0b21168a78
commit 29ea125179
101 changed files with 947 additions and 75 deletions

View File

@@ -0,0 +1,33 @@
# PC-QBittorrent Role
## Overview
This README is for the `pc-qbittorrent` role within the `computer-playbook` repository. This role is specifically crafted for installing qBittorrent, a popular open-source torrent client, on personal computers.
## Role Tasks
The `main.yml` file in the `pc-qbittorrent` role includes the following task:
1. **Install Torrent Software**:
- This task uses the `kewlfft.aur.aur` module with `yay` as the AUR helper to install `qbittorrent`, a widely-used, free, and easy-to-use torrent client.
## Dependencies
This role depends on:
- **system-aur-helper**: Ensures that an Arch User Repository (AUR) helper is installed, which is necessary for installing packages like `qbittorrent` that are not available in the standard repositories.
## Purpose and Usage
The `pc-qbittorrent` role is tailored for users who require a reliable and user-friendly torrent client for downloading and sharing files via the BitTorrent protocol. qBittorrent is known for its balance of features, simplicity, and minimal impact on system resources.
## Prerequisites
- **Ansible**: Required for running this role.
- **Arch Linux-based System**: The role is designed with Arch Linux distributions in mind, leveraging AUR helpers for package installation.
## Running the Role
To utilize this role:
1. Clone the `computer-playbook` repository.
2. Navigate to the `roles/pc-qbittorrent` directory.
3. Execute the role using Ansible, ensuring you have the required system permissions for package installation.
## Customization
This role is primarily focused on installing qBittorrent, but it can be customized to include additional configurations or related software packages as needed.
## Support and Contributions
For support, feedback, or contributions, such as enhancing the role or adding additional torrent-related functionality, please open an issue or submit a pull request in the `computer-playbook` repository. Contributions that enhance the usability or features of qBittorrent within this role are highly appreciated.

View File

@@ -0,0 +1,2 @@
dependencies:
- system-aur-helper

View File

@@ -0,0 +1,5 @@
- name: install torrent software
kewlfft.aur.aur:
use: yay
name:
- qbittorrent