qBit Manage

Description / name	Input element
Your domain name

Overview

qBit Manage is a program used to manage your qBittorrent instance.

Manual

Releases

Community

---

Configuration

The following variables are available to set in the sandbox settings.yml file. An explanation of these settings can be found here.

qbit_manage:
  qbt_run: "false" # Default is "false"
  qbt_schedule: "30" # Default is "30"
  qbt_config: "config.yml" # Default is "config.yml"
  qbt_logfile: "activity.log" # Default is "activity.log"
  qbt_cross_seed: "false" # Default is "false"
  qbt_recheck: "false" # Default is "false"
  qbt_cat_update: "false" # Default is "false"
  qbt_tag_update: "false" # Default is "false"
  qbt_rem_unregistered: "false" # Default is "false"
  qbt_rem_orphaned: "false" # Default is "false"
  qbt_tag_nohardlinks: "false" # Default is "false"
  qbt_skip_recycle: "false" # Default is "false"
  qbt_dry_run: "true" # Default is "false"
  qbt_log_level: "INFO" # Default is "INFO"
  qbt_divider: "=" # Default is "="
  qbt_width: "100" # Default is "100"

Deployment

Before installing qBit Manage, you should have a qBittorrent instance running on your local machine.

sb install sandbox-qbit-manage

Usage

Visit https://qbit-manage.iYOUR_DOMAIN_NAMEi.

Basics

After installation has finished, stop the qbit-manage docker container and edit the config file that will have been created at /opt/qbit-manage/config.yml

docker stop qbit-manage

Minimally you will need to change the following items in order to connect with your qBittorrent instance:-

    qbt:
      host: "qbittorrent:8080"
      user: "qbittorrent_username"
      pass: "qbittorrent_password"

    directory:
      cross_seed: "/your/path/here/"
      root_dir: "/mnt/unionfs/downloads/torrents/qbittorrent/completed/"
      remote_dir: "/mnt/unionfs/torrents/your/path/here/"

An indepth explanation of the config file settings can be found here.

The config file is full of examples that more than likely will not work for you, sections you aren't using can be safely commented out or left blank. An up to date example configuration file can be found here when you wish to add newer features or restore a self mangled section. YAML spacing matters.

After making adjustments to the config file, you can start the docker container again.

docker start qbit-manage

Either tail the log ( tail -f "/opt/qbit-manage/logs/activity.log" ) or open the log file after a few minutes to check for any errors or behaviour that may have been unexpected. The container has been deliberately set to DRY RUN MODE initially so you can see what the script will do without actually moving deleting, tagging, or categorising anything.. Once you are happy your life's work will not be destroyed and any errors have been resolved you can edit the qbit_manage variables in the sandbox settings.yml file and then run the role again. Set qbt_dry_run: false to run in live mode. This will delete and move files according to your settings.

Apply the changes to the sandbox settings file with:

sb install sandbox-qbit-manage

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   qbit_manage_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like qbit_manage_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like qbit_manage_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

qbit_manage_name

# Type: string
qbit_manage_name: qbit-manage

qbit_manage_role_web_subdomain

# Type: string
qbit_manage_role_web_subdomain: "{{ qbit_manage_name }}"

qbit_manage_role_web_domain

# Type: string
qbit_manage_role_web_domain: "{{ user.domain }}"

qbit_manage_role_web_port

# Type: string
qbit_manage_role_web_port: "8080"

qbit_manage_role_web_url

# Type: string
qbit_manage_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='qbit_manage') + '.' + lookup('role_var', '_web_domain', role='qbit_manage')
                           if (lookup('role_var', '_web_subdomain', role='qbit_manage') | length > 0)
                           else lookup('role_var', '_web_domain', role='qbit_manage')) }}"

qbit_manage_role_dns_record

# Type: string
qbit_manage_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='qbit_manage') }}"

qbit_manage_role_dns_zone

# Type: string
qbit_manage_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='qbit_manage') }}"

qbit_manage_role_dns_proxy

# Type: bool (true/false)
qbit_manage_role_dns_proxy: "{{ dns_proxied }}"

qbit_manage_role_traefik_sso_middleware

# Type: string
qbit_manage_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

qbit_manage_role_traefik_middleware_default

# Type: string
qbit_manage_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

qbit_manage_role_traefik_middleware_custom

# Type: string
qbit_manage_role_traefik_middleware_custom: ""

qbit_manage_role_traefik_certresolver

# Type: string
qbit_manage_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

qbit_manage_role_traefik_enabled

# Type: bool (true/false)
qbit_manage_role_traefik_enabled: true

qbit_manage_role_traefik_api_enabled

# Type: bool (true/false)
qbit_manage_role_traefik_api_enabled: true

qbit_manage_role_traefik_api_endpoint

# Type: string
qbit_manage_role_traefik_api_endpoint: "PathPrefix(`/api`)"

Container

qbit_manage_role_docker_container

# Type: string
qbit_manage_role_docker_container: "{{ qbit_manage_name }}"

Image

qbit_manage_role_docker_image_pull

# Type: bool (true/false)
qbit_manage_role_docker_image_pull: true

qbit_manage_role_docker_image_repo

# Type: string
qbit_manage_role_docker_image_repo: "ghcr.io/hotio/qbitmanage"

qbit_manage_role_docker_image_tag

# Type: string
qbit_manage_role_docker_image_tag: "release"

qbit_manage_role_docker_image

# Type: string
qbit_manage_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='qbit_manage') }}:{{ lookup('role_var', '_docker_image_tag', role='qbit_manage') }}"

Ports

qbit_manage_role_docker_ports_default

# Type: list
qbit_manage_role_docker_ports_default: []

qbit_manage_role_docker_ports_custom

# Type: list
qbit_manage_role_docker_ports_custom: []

Envs

qbit_manage_role_docker_envs_default

# Type: dict
qbit_manage_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  UMASK: "002"
  TZ: "{{ tz }}"
  QBT_WEB_SERVER: "true"
  QBT_RUN: "{{ qbit_manage.qbt_run }}"
  QBT_SCHEDULE: "{{ qbit_manage.qbt_schedule }}"
  QBT_CONFIG: "{{ qbit_manage.qbt_config }}"
  QBT_LOGFILE: "{{ qbit_manage.qbt_logfile }}"
  QBT_CROSS_SEED: "{{ qbit_manage.qbt_cross_seed }}"
  QBT_RECHECK: "{{ qbit_manage.qbt_recheck }}"
  QBT_CAT_UPDATE: "{{ qbit_manage.qbt_cat_update }}"
  QBT_TAG_UPDATE: "{{ qbit_manage.qbt_tag_update }}"
  QBT_REM_UNREGISTERED: "{{ qbit_manage.qbt_rem_unregistered }}"
  QBT_REM_ORPHANED: "{{ qbit_manage.qbt_rem_orphaned }}"
  QBT_TAG_NOHARDLINKS: "{{ qbit_manage.qbt_tag_nohardlinks }}"
  QBT_SKIP_RECYCLE: "{{ qbit_manage.qbt_skip_recycle }}"
  QBT_DRY_RUN: "{{ qbit_manage.qbt_dry_run }}"
  QBT_LOG_LEVEL: "{{ qbit_manage.qbt_log_level }}"
  QBT_DIVIDER: "{{ qbit_manage.qbt_divider }}"
  QBT_WIDTH: "{{ qbit_manage.qbt_width }}"
  QBT_DEBUG: "{{ qbit_manage.qbt_debug }}"
  QBT_TRACE: "{{ qbit_manage.qbt_trace }}"

qbit_manage_role_docker_envs_custom

# Type: dict
qbit_manage_role_docker_envs_custom: {}

Volumes

qbit_manage_role_docker_volumes_default

# Type: list
qbit_manage_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='qbit_manage') }}:/config"

qbit_manage_role_docker_volumes_custom

# Type: list
qbit_manage_role_docker_volumes_custom: []

Hostname

qbit_manage_role_docker_hostname

# Type: string
qbit_manage_role_docker_hostname: "{{ qbit_manage_name }}"

Networks

qbit_manage_role_docker_networks_alias

# Type: string
qbit_manage_role_docker_networks_alias: "{{ qbit_manage_name }}"

qbit_manage_role_docker_networks_default

# Type: list
qbit_manage_role_docker_networks_default: []

qbit_manage_role_docker_networks_custom

# Type: list
qbit_manage_role_docker_networks_custom: []

Restart Policy

qbit_manage_role_docker_restart_policy

# Type: string
qbit_manage_role_docker_restart_policy: on-failure

qbit_manage_role_docker_restart_retries

# Type: int
qbit_manage_role_docker_restart_retries: 3

State

qbit_manage_role_docker_state

# Type: string
qbit_manage_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

qbit_manage_role_docker_blkio_weight

# Type: int
qbit_manage_role_docker_blkio_weight:

qbit_manage_role_docker_cpu_period

# Type: int
qbit_manage_role_docker_cpu_period:

qbit_manage_role_docker_cpu_quota

# Type: int
qbit_manage_role_docker_cpu_quota:

qbit_manage_role_docker_cpu_shares

# Type: int
qbit_manage_role_docker_cpu_shares:

qbit_manage_role_docker_cpus

# Type: string
qbit_manage_role_docker_cpus:

qbit_manage_role_docker_cpuset_cpus

# Type: string
qbit_manage_role_docker_cpuset_cpus:

qbit_manage_role_docker_cpuset_mems

# Type: string
qbit_manage_role_docker_cpuset_mems:

qbit_manage_role_docker_kernel_memory

# Type: string
qbit_manage_role_docker_kernel_memory:

qbit_manage_role_docker_memory

# Type: string
qbit_manage_role_docker_memory:

qbit_manage_role_docker_memory_reservation

# Type: string
qbit_manage_role_docker_memory_reservation:

qbit_manage_role_docker_memory_swap

# Type: string
qbit_manage_role_docker_memory_swap:

qbit_manage_role_docker_memory_swappiness

# Type: int
qbit_manage_role_docker_memory_swappiness:

qbit_manage_role_docker_shm_size

# Type: string
qbit_manage_role_docker_shm_size:

Security & Devices

qbit_manage_role_docker_cap_drop

# Type: list
qbit_manage_role_docker_cap_drop:

qbit_manage_role_docker_cgroupns_mode

# Type: string
qbit_manage_role_docker_cgroupns_mode:

qbit_manage_role_docker_device_cgroup_rules

# Type: list
qbit_manage_role_docker_device_cgroup_rules:

qbit_manage_role_docker_device_read_bps

# Type: list
qbit_manage_role_docker_device_read_bps:

qbit_manage_role_docker_device_read_iops

# Type: list
qbit_manage_role_docker_device_read_iops:

qbit_manage_role_docker_device_requests

# Type: list
qbit_manage_role_docker_device_requests:

qbit_manage_role_docker_device_write_bps

# Type: list
qbit_manage_role_docker_device_write_bps:

qbit_manage_role_docker_device_write_iops

# Type: list
qbit_manage_role_docker_device_write_iops:

qbit_manage_role_docker_devices

# Type: list
qbit_manage_role_docker_devices:

qbit_manage_role_docker_devices_default

# Type: string
qbit_manage_role_docker_devices_default:

qbit_manage_role_docker_groups

# Type: list
qbit_manage_role_docker_groups:

qbit_manage_role_docker_privileged

# Type: bool (true/false)
qbit_manage_role_docker_privileged:

qbit_manage_role_docker_security_opts

# Type: list
qbit_manage_role_docker_security_opts:

qbit_manage_role_docker_user

# Type: string
qbit_manage_role_docker_user:

qbit_manage_role_docker_userns_mode

# Type: string
qbit_manage_role_docker_userns_mode:

Networking

qbit_manage_role_docker_dns_opts

# Type: list
qbit_manage_role_docker_dns_opts:

qbit_manage_role_docker_dns_search_domains

# Type: list
qbit_manage_role_docker_dns_search_domains:

qbit_manage_role_docker_dns_servers

# Type: list
qbit_manage_role_docker_dns_servers:

qbit_manage_role_docker_domainname

# Type: string
qbit_manage_role_docker_domainname:

qbit_manage_role_docker_exposed_ports

# Type: list
qbit_manage_role_docker_exposed_ports:

qbit_manage_role_docker_hosts

# Type: dict
qbit_manage_role_docker_hosts:

qbit_manage_role_docker_hosts_use_common

# Type: bool (true/false)
qbit_manage_role_docker_hosts_use_common:

qbit_manage_role_docker_ipc_mode

# Type: string
qbit_manage_role_docker_ipc_mode:

qbit_manage_role_docker_links

# Type: list
qbit_manage_role_docker_links:

qbit_manage_role_docker_network_mode

# Type: string
qbit_manage_role_docker_network_mode:

qbit_manage_role_docker_pid_mode

# Type: string
qbit_manage_role_docker_pid_mode:

qbit_manage_role_docker_uts

# Type: string
qbit_manage_role_docker_uts:

Storage

qbit_manage_role_docker_keep_volumes

# Type: bool (true/false)
qbit_manage_role_docker_keep_volumes:

qbit_manage_role_docker_mounts

# Type: list
qbit_manage_role_docker_mounts:

qbit_manage_role_docker_storage_opts

# Type: dict
qbit_manage_role_docker_storage_opts:

qbit_manage_role_docker_tmpfs

# Type: list
qbit_manage_role_docker_tmpfs:

qbit_manage_role_docker_volume_driver

# Type: string
qbit_manage_role_docker_volume_driver:

qbit_manage_role_docker_volumes_from

# Type: list
qbit_manage_role_docker_volumes_from:

qbit_manage_role_docker_volumes_global

# Type: bool (true/false)
qbit_manage_role_docker_volumes_global:

qbit_manage_role_docker_working_dir

# Type: string
qbit_manage_role_docker_working_dir:

Monitoring & Lifecycle

qbit_manage_role_docker_auto_remove

# Type: bool (true/false)
qbit_manage_role_docker_auto_remove:

qbit_manage_role_docker_cleanup

# Type: bool (true/false)
qbit_manage_role_docker_cleanup:

qbit_manage_role_docker_force_kill

# Type: string
qbit_manage_role_docker_force_kill:

qbit_manage_role_docker_healthcheck

# Type: dict
qbit_manage_role_docker_healthcheck:

qbit_manage_role_docker_healthy_wait_timeout

# Type: int
qbit_manage_role_docker_healthy_wait_timeout:

qbit_manage_role_docker_init

# Type: bool (true/false)
qbit_manage_role_docker_init:

qbit_manage_role_docker_kill_signal

# Type: string
qbit_manage_role_docker_kill_signal:

qbit_manage_role_docker_log_driver

# Type: string
qbit_manage_role_docker_log_driver:

qbit_manage_role_docker_log_options

# Type: dict
qbit_manage_role_docker_log_options:

qbit_manage_role_docker_oom_killer

# Type: bool (true/false)
qbit_manage_role_docker_oom_killer:

qbit_manage_role_docker_oom_score_adj

# Type: int
qbit_manage_role_docker_oom_score_adj:

qbit_manage_role_docker_output_logs

# Type: bool (true/false)
qbit_manage_role_docker_output_logs:

qbit_manage_role_docker_paused

# Type: bool (true/false)
qbit_manage_role_docker_paused:

qbit_manage_role_docker_recreate

# Type: bool (true/false)
qbit_manage_role_docker_recreate:

qbit_manage_role_docker_stop_timeout

# Type: int
qbit_manage_role_docker_stop_timeout:

Other Options

qbit_manage_role_docker_capabilities

# Type: list
qbit_manage_role_docker_capabilities:

qbit_manage_role_docker_cgroup_parent

# Type: string
qbit_manage_role_docker_cgroup_parent:

qbit_manage_role_docker_commands

# Type: list
qbit_manage_role_docker_commands:

qbit_manage_role_docker_create_timeout

# Type: int
qbit_manage_role_docker_create_timeout:

qbit_manage_role_docker_entrypoint

# Type: string
qbit_manage_role_docker_entrypoint:

qbit_manage_role_docker_env_file

# Type: string
qbit_manage_role_docker_env_file:

qbit_manage_role_docker_labels

# Type: dict
qbit_manage_role_docker_labels:

qbit_manage_role_docker_labels_use_common

# Type: bool (true/false)
qbit_manage_role_docker_labels_use_common:

qbit_manage_role_docker_read_only

# Type: bool (true/false)
qbit_manage_role_docker_read_only:

qbit_manage_role_docker_runtime

# Type: string
qbit_manage_role_docker_runtime:

qbit_manage_role_docker_sysctls

# Type: list
qbit_manage_role_docker_sysctls:

qbit_manage_role_docker_ulimits

# Type: list
qbit_manage_role_docker_ulimits:

qbit_manage_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
qbit_manage_role_autoheal_enabled: true

qbit_manage_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
qbit_manage_role_depends_on: ""

qbit_manage_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
qbit_manage_role_depends_on_delay: "0"

qbit_manage_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
qbit_manage_role_depends_on_healthchecks:

qbit_manage_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
qbit_manage_role_diun_enabled: true

qbit_manage_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
qbit_manage_role_dns_enabled: true

qbit_manage_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
qbit_manage_role_docker_controller: true

qbit_manage_role_docker_image_repo

# Type: string
qbit_manage_role_docker_image_repo:

qbit_manage_role_docker_image_tag

# Type: string
qbit_manage_role_docker_image_tag:

qbit_manage_role_docker_volumes_download

# Type: bool (true/false)
qbit_manage_role_docker_volumes_download:

qbit_manage_role_paths_location

# Type: string
qbit_manage_role_paths_location:

qbit_manage_role_themepark_addons

# Type: string
qbit_manage_role_themepark_addons:

qbit_manage_role_themepark_app

# Type: string
qbit_manage_role_themepark_app:

qbit_manage_role_themepark_theme

# Type: string
qbit_manage_role_themepark_theme:

qbit_manage_role_traefik_api_endpoint

# Type: dict/omit
qbit_manage_role_traefik_api_endpoint:

qbit_manage_role_traefik_api_middleware

# Type: string
qbit_manage_role_traefik_api_middleware:

qbit_manage_role_traefik_api_middleware_http

# Type: string
qbit_manage_role_traefik_api_middleware_http:

qbit_manage_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
qbit_manage_role_traefik_autodetect_enabled: false

qbit_manage_role_traefik_certresolver

# Type: string
qbit_manage_role_traefik_certresolver:

qbit_manage_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
qbit_manage_role_traefik_crowdsec_enabled: false

qbit_manage_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
qbit_manage_role_traefik_error_pages_enabled: false

qbit_manage_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
qbit_manage_role_traefik_gzip_enabled: false

qbit_manage_role_traefik_middleware_http

# Type: string
qbit_manage_role_traefik_middleware_http:

qbit_manage_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
qbit_manage_role_traefik_middleware_http_api_insecure:

qbit_manage_role_traefik_middleware_http_insecure

# Type: bool (true/false)
qbit_manage_role_traefik_middleware_http_insecure:

qbit_manage_role_traefik_priority

# Type: string
qbit_manage_role_traefik_priority:

qbit_manage_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
qbit_manage_role_traefik_robot_enabled: true

qbit_manage_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
qbit_manage_role_traefik_tailscale_enabled: false

qbit_manage_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
qbit_manage_role_traefik_wildcard_enabled: true

qbit_manage_role_web_domain

# Type: string
qbit_manage_role_web_domain:

qbit_manage_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
qbit_manage_role_web_fqdn_override:

Example Override

qbit_manage_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "qbit_manage2.{{ user.domain }}"
  - "qbit_manage.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

qbit_manage_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
qbit_manage_role_web_host_override:

Example Override

qbit_manage_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'qbit_manage2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

qbit_manage_role_web_http_port

# Type: string (quoted number)
qbit_manage_role_web_http_port:

qbit_manage_role_web_http_scheme

# Type: string ("http"/"https")
qbit_manage_role_web_http_scheme:

qbit_manage_role_web_http_serverstransport

# Type: dict/omit
qbit_manage_role_web_http_serverstransport:

qbit_manage_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
qbit_manage_role_web_scheme:

qbit_manage_role_web_serverstransport

# Type: dict/omit
qbit_manage_role_web_serverstransport:

qbit_manage_role_web_subdomain

# Type: string
qbit_manage_role_web_subdomain: