Ansible Role: rTorrent

This Ansible role is designed to help you install and set up rTorrent.

Role Variables

# Packages for different distributions can be specified in ``vars/``.
# You can change these values to skip installation or use different packages.
rtorrent_packages: []

rtorrent_basedir: "~/rtorrent"  # Main directory for rTorrent
rtorrent_rc_path: "~/.rtorrent.rc"  # Configuration file for rTorrent

# ----- Bandwidth settings -----
rtorrent_min_peers: 40  # Minimum number of peers
rtorrent_max_peers: 100  # Maximum number of peers
rtorrent_min_peers_seed: 10  # Minimum number of seed peers
rtorrent_max_peers_seed: 50  # Maximum number of seed peers
rtorrent_max_uploads: 15  # Maximum number of uploads
rtorrent_max_global_downloads: 300  # Global max downloads
rtorrent_max_global_uploads: 300  # Global max uploads
rtorrent_download_rate: 0  # Download rate limit (0 means no limit)
rtorrent_upload_rate: 0  # Upload rate limit (0 means no limit)
rtorrent_numwant: -1  # Number of wanted peers

# ----- Directory settings -----
rtorrent_directory_download: "{{ rtorrent_basedir }}/download"  # Directory for downloads
rtorrent_directory_session: "{{ rtorrent_basedir }}/session"  # Session directory

# The directory to watch for new torrents can be a simple path or a list with multiple paths.
# 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
rtorrent_directory_watch: "{{ rtorrent_basedir }}/watch"

# Move completed torrents to the download directory
rtorrent_move_when_complete: false  # Set to true to move completed torrents

# ----- Network settings -----
rtorrent_port_range: 49164-49164  # Port range for rTorrent
rtorrent_port_random: "no"  # Set to "yes" to use random ports
rtorrent_ssl_verify_peer: 0  # Peer SSL verification
rtorrent_max_open_sockets: 999  # Max open sockets
rtorrent_max_open_files: 1024  # Max open files
rtorrent_max_open_http: 32  # Max open HTTP connections
rtorrent_receive_buffer_size: 0  # Receive buffer size (0 means it uses default)
rtorrent_send_buffer_size: 0  # Send buffer size (0 means it uses default)
rtorrent_dns_cache_timeout: 60  # DNS cache timeout
rtorrent_xmlrpc_size_limit: 524288  # XML-RPC size limit

# ----- Schedule settings -----
rtorrent_global_refresh_time: 5  # Refresh time for watch directories
rtorrent_schedule_untied_directory: "untied_directory,{{ rtorrent_global_refresh_time }},{{ rtorrent_global_refresh_time }},stop_untied="

# ----- Torrent settings -----
rtorrent_check_hash: "no"  # Whether to check file hash
rtorrent_use_udp_trackers: "yes"  # Use UDP trackers
rtorrent_tracker_numwant: -1  # Number of tracker peers to request
rtorrent_encryption: "allow_incoming,enable_retry,prefer_plaintext"  # Encryption settings
rtorrent_dht: "off"  # Distributed Hash Table
rtorrent_dht_port: 6881  # Port for DHT
rtorrent_peer_exchange: "yes"  # Enable peer exchange

# ----- Memory and pieces buffers -----
rtorrent_max_memory_usage: "1024M"  # Max memory usage
rtorrent_pieces_preload_type: 0  # Preload type for pieces
rtorrent_pieces_preload_min_size: 262144  # Min size for preloading
rtorrent_pieces_preload_min_rate: 5120  # Min rate for preloading

# ----- Other settings -----
# (Misconfiguration can break rTorrent)
rtorrent_file_allocate: 0  # File allocation method
rtorrent_delete_erased: false  # Delete data from erased torrents
rtorrent_other_settings: []  # Any other custom settings
# Example
#    - scgi_port = 127.0.0.1:5000

Dependencies

None Required.

Example Playbook

1. Set up rTorrent with default settings

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

2. Set up rTorrent with custom settings

- hosts: servers-torrent
  roles:
    - role: Anthony25.rTorrent
      rtorrent_min_peers: 0  # Set minimum peers to 0
      rtorrent_max_peers: 1000  # Set maximum peers to 1000

License

BSD License

Author Information

Written by Anthony25 Based on work from Prescott Chris.