QBittorrent

Description

Installs the qBittorrent torrent client from the distribution repositories.

Overview

This README is for the dsk-qbittorrent role within the infinito repository. This role is specifically crafted for installing qBittorrent, a popular open-source torrent client, on personal computers.

Architecture

ARCHITECTURE.md draws QBittorrent from its own metadata: the containers it runs under compose, what changes under swarm, how each volume is backed, and every role it depends on or is depended upon by.

Section

Drawn from

Compose

meta/services.yml

Swarm

meta/services.yml replicas and placement

Volumes

meta/volumes.yml against the NFS decision chain

Dependencies

meta/services.yml and meta/main.yml of every role

Features

  • Automated provisioning: Configured by Ansible without manual steps.

Quick Setup

Development

Clone, set up the workstation, and deploy QBittorrent onto the local stack:

git clone https://github.com/infinito-nexus/core.git
cd core
make onboard
make compose-deploy mode=reinstall apps=dsk-qbittorrent full_cycle=false

Production

Install QBittorrent directly onto the target machine: clone the repository, install the OS prerequisites and the repository toolchain, then deploy against localhost over a local connection (no SSH, no container):

git clone https://github.com/infinito-nexus/core.git
cd core
bash scripts/install/package.sh
make install
source scripts/meta/env/load.sh

APP=dsk-qbittorrent
DOMAIN="<your-domain>"
TLS_MODE=self_signed
SSH_PUBLIC_KEY="<your-ssh-public-key>"
INVENTORY=inventories/production
infinito administration inventory provision "$INVENTORY" \
  --inventory-file "$INVENTORY/devices.yml" \
  --host localhost \
  --include "$APP" \
  --vars "{\"TLS_MODE\": \"$TLS_MODE\", \"DOMAIN_PRIMARY\": \"$DOMAIN\", \"users\": {\"administrator\": {\"authorized_keys\": [\"$SSH_PUBLIC_KEY\"]}}}"
infinito administration deploy dedicated "$INVENTORY/devices.yml" \
  --password-file "$INVENTORY/.password" \
  --diff -vv

Credits

Kevin Veen-Birkenbach

Part of the Infinito.Nexus Project and maintained by Kevin Veen-Birkenbach. Licensed under the Infinito.Nexus Community License (Non-Commercial).

That licence covers this role. The software it deploys is a separate grant: GPL-3.0-or-later, under which commercial use is allowed. You owe its authors this much: publish the source of changes you distribute. Permission for one of the two is not permission for the other.

Role Tasks

The main.yml file in the dsk-qbittorrent role includes the following task:

  1. Install Torrent Software:

    • The package batch the constructor runs at deploy start installs the qbittorrent id; the per-distribution names are declared in meta/packages.yml.

Purpose and Usage

The dsk-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.

  • Supported distribution: Arch, Debian, Ubuntu, Fedora or CentOS Stream, where CentOS resolves qbittorrent through EPEL.

Running the Role

To utilize this role:

  1. Clone the infinito repository.

  2. Navigate to the roles/dsk-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 infinito repository. Contributions that enhance the usability or features of qBittorrent within this role are highly appreciated.