tqm¶

Overview¶

tqm is a command-line tool designed to manage torrent client queues, with a primary focus on automatically removing torrents that meet specific user-defined criteria.

Manual

Releases

Community

Sandbox settings.yml Deprecation

As of role-refactor, settings.yml is no longer used to configure Sandbox roles. Values currently set in /opt/sandbox/settings.yml must be migrated to their Inventory form. See Role Defaults for the expected syntax.

Configuration¶

Set your download client via the Inventory override.
Edit /opt/tqm/config.yaml.

Use Saltbox paths (/mnt/unionfs/downloads/...) for download_path as per Saltbox media paths.

Example client config:

deluge:
  enabled: false
  download_path: /mnt/unionfs/downloads/torrents/deluge
  free_space_path: /mnt/local/downloads/torrents/deluge
  download_path_mapping:
    /downloads/torrents/deluge: /mnt/unionfs/downloads/torrents/deluge
  host: deluge
  login: localclient
  password: password-from-/opt/deluge/auth
  port: 58846
  type: deluge
  v2: true
qbt:
  enabled: true
  download_path: /mnt/unionfs/downloads/torrents/qbittorrent/completed
  free_space_path: /mnt/local/downloads/torrents/qbittorrent/completed
  download_path_mapping:
    /mnt/unionfs/downloads/torrents/qbittorrent/completed: /mnt/unionfs/downloads/torrents/qbittorrent/completed
  type: qbittorrent
  url: http://qbittorrent:8080
  user: seed
  password: super_strong_password

See the main documentation for full configuration and filter options.

Deployment¶

sb install sandbox-tqm

Usage¶

Check service status:

sudo systemctl status tqm.service

View logs:

tail -f /opt/tqm/activity.log

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
tqm_name: "custom_value"
```

Basics

tqm_name

# Type: string
tqm_name: tqm