Ansible Role: rTorrent

Ansible role to install and configure rTorrent.

Requirements

# Ansible version 2.0.0.2+
ansible --version

# OS
case $OSTYPE in
  # Linux needs apt|yum|dnf|zypper
  "linux"*)
      apt --version||yum --version;;
  # OS X needs nothing
  "freebsd"*)
      pkgng --version;;
esac

Role Variables

# ----- bandwidth settings -----
rtorrent_min_peers: 40
rtorrent_max_peers: 100
rtorrent_min_peers_seed: 10
rtorrent_max_peers_seed: 50
rtorrent_max_uploads: 15
rtorrent_max_global_downloads: 300
rtorrent_max_global_uploads: 300
rtorrent_download_rate: 0
rtorrent_upload_rate: 0
rtorrent_numwant: -1

# ----- directory settings -----
rtorrent_directory_download: ~/rtorrent/download
rtorrent_directory_session: ~/rtorrent/.session

# directory_watch can be a directory path (like the default value), a dict or
# a list of dicts for multiple watch directories.
# Example for one watch directory:
#   rtorrent_directory_watch:
#     path: ~/rtorrent/watch
#     refresh_time: 10
#     download: ~/rtorrent/download_complete
# Example for multiple watch directories:
#   rtorrent_directory_watch:
#     - ~/rtorrent/watch
#     - path: ~/rtorrent/watch1
#       refresh_time: 30
#     - path: ~/rtorrent/watch2
#       download: ~/rtorrent/download_custom
# When not set, refresh_time={{ rtorrent_global_refresh_time }} and
# download={{ rtorrent_directory_download }}
rtorrent_directory_watch: ~/rtorrent/watch

# Move completed torrents to the download directory as set in their watch
# directory
rtorrent_move_when_complete: false

# ----- network settings -----
rtorrent_port_range: 49164-49164
rtorrent_port_random: "no"
rtorrent_ssl_verify_peer: 0
rtorrent_max_open_sockets: 999
rtorrent_max_open_files: 1024
rtorrent_max_open_http: 32
rtorrent_receive_buffer_size: 0
rtorrent_send_buffer_size: 0
rtorrent_dns_cache_timeout: 60
rtorrent_xmlrpc_size_limit: 524288

# ----- schedule settings -----
# Set refresh time for untied_directory and watch directories
rtorrent_global_refresh_time: 5
rtorrent_schedule_untied_directory: "untied_directory,{{ rtorrent_global_refresh_time }},{{ rtorrent_global_refresh_time }},stop_untied="

# ----- torrent settings -----
rtorrent_check_hash: "no"
rtorrent_use_udp_trackers: "yes"
rtorrent_tracker_numwant: -1
rtorrent_encryption: "allow_incoming,enable_retry,prefer_plaintext"
rtorrent_dht: "off"
rtorrent_dht_port: 6881
rtorrent_peer_exchange: "yes"

# ----- memory and pieces buffers -----
rtorrent_max_memory_usage: "1024M"
rtorrent_pieces_preload_type: 0
rtorrent_pieces_preload_min_size: 262144
rtorrent_pieces_preload_min_rate: 5120

# ----- other settings -----
#  (can break rtorrent when misconfigured)
rtorrent_file_allocate: 0
rtorrent_other_settings: []
# Example
#    - scgi_port = 127.0.0.1:5000

Dependencies

None

Example Playbook

1. Install rTorrent with default settings

- hosts: servers-torrent
  roles:
    - role: cmprescott.rTorrent

2. Install rTorrent with custom settings

- hosts: servers-torrent
  roles:
    - role: cmprescott.rTorrent
      rtorrent_min_peers: 0
      rtorrent_max_peers: 1000

License

BSD

Author Information

Prescott Chris