RTorrent - Revision history

Tie-ling: /* Use customized rtorrent.rc */ uses new style syntax

2026-11-01T23:51:30Z

Use customized rtorrent.rc: uses new style syntax

← Older revision		Revision as of 23:51, 1 November 2026
Line 204:		Line 204:

	# erase torrent data when the torrent is deregistered from rtorrent		# erase torrent data when the torrent is deregistered from rtorrent
	method.set_key = event.download.erased,delete_erased,"execute.nothrow.bg=rm,-rf,--,$d.base_path="		# uses new style syntax
			# https://github.com/rakshasa/rtorrent/wiki/Parentheses-and-Braces-Syntax
			method.set_key = event.download.erased,delete_erased,((execute.nothrow.bg, rm, -rf, --, ((d.base_path)) ))

	dht.mode.set = auto		dht.mode.set = auto

Tie-ling: /* Control rtorrent with pyrosimple */ bold font for warning

2026-11-01T23:20:00Z

Control rtorrent with pyrosimple: bold font for warning

← Older revision		Revision as of 23:20, 1 November 2026
Line 263:		Line 263:
	Further documentation on pyrosimple can be found on its website https://kannibalox.github.io/pyrosimple/		Further documentation on pyrosimple can be found on its website https://kannibalox.github.io/pyrosimple/

	Warning: Do not use configuration generated by pyrosimple, the result is incompatible with ~~latest~~ rtorrent versions. See for example https://github.com/kannibalox/pyrosimple/issues/80		'''Warning''': Do not use configuration generated by pyrosimple, the result is incompatible with newer rtorrent versions. See for example https://github.com/kannibalox/pyrosimple/issues/80
	[[Category:Server]]		[[Category:Server]]

Tie-ling: /* Use customized rtorrent.rc */ add bold warning

2026-11-01T23:19:29Z

Use customized rtorrent.rc: add bold warning

← Older revision		Revision as of 23:19, 1 November 2026
Line 180:		Line 180:

	The following is a minimal working example, which shows how you could combine the power of nix with a custom rtorrent.rc configuration file.		The following is a minimal working example, which shows how you could combine the power of nix with a custom rtorrent.rc configuration file.

			'''Warning''': The example below was only tested with v0.16.27. Some commands were newly introduced and thus incompatible with older releases.

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">

Tie-ling: /* Use customized rtorrent.rc */ tested only on 0.16.27

2026-11-01T23:13:51Z

Use customized rtorrent.rc: tested only on 0.16.27

← Older revision		Revision as of 23:13, 1 November 2026
Line 185:		Line 185:
	{		{
	# this is a minimal working example with inessential comments pruned.		# this is a minimal working example with inessential comments pruned.
			# Tested on rTorrent v0.16.27. Incompatible with older rTorrent releases
	# see https://github.com/rakshasa/rtorrent/blob/master/doc/rtorrent.rc-example		# see https://github.com/rakshasa/rtorrent/blob/master/doc/rtorrent.rc-example
	# for commented configuration		# for commented configuration

Tie-ling: /* Use customized rtorrent.rc */ minimal working example

2026-11-01T23:01:28Z

Use customized rtorrent.rc: minimal working example

← Older revision		Revision as of 23:01, 1 November 2026
Line 179:		Line 179:
	By default, rtorrent.rc is generated by Nix. But the auto-generated file does not do justice to the versatility of rtorrent configuration. By using a customized rtorrent.rc file, you can choose what should happen when a torrent has finished downloading, whether to erase the torrent data when the torrent file is removed, and much more. A further motivation is that, with the rapid development of rtorrent as of Nov. 2026, the configuration file format is changing. For best results, one should directly apply recommendations found in the rtorrent GitHub repo instead of relying on nix auto-generation.		By default, rtorrent.rc is generated by Nix. But the auto-generated file does not do justice to the versatility of rtorrent configuration. By using a customized rtorrent.rc file, you can choose what should happen when a torrent has finished downloading, whether to erase the torrent data when the torrent file is removed, and much more. A further motivation is that, with the rapid development of rtorrent as of Nov. 2026, the configuration file format is changing. For best results, one should directly apply recommendations found in the rtorrent GitHub repo instead of relying on nix auto-generation.

	The following shows how you could combine the power of nix with a custom rtorrent.rc configuration file.		The following is a minimal working example, which shows how you could combine the power of nix with a custom rtorrent.rc configuration file.

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	{ pkgs, lib, config, ... }:		{ pkgs, lib, config, ... }:
	{		{
	# inessential comments pruned~~, see~~		# this is a minimal working example with inessential comments pruned.
	# https://github.com/rakshasa/rtorrent/blob/master/doc/rtorrent.rc-example		# see https://github.com/rakshasa/rtorrent/blob/master/doc/rtorrent.rc-example
	# for commented configuration		# for commented configuration
	# https://raw.githubusercontent.com/NixOS/nixpkgs/refs/heads/nixos-26.05/nixos/modules/services/torrent/rtorrent.nix		# https://raw.githubusercontent.com/NixOS/nixpkgs/refs/heads/nixos-26.05/nixos/modules/services/torrent/rtorrent.nix

Tie-ling: use ssh tunnel

2026-11-01T22:14:26Z

use ssh tunnel

← Older revision		Revision as of 22:14, 1 November 2026
Line 87:		Line 87:
	= rTorrent with ruTorrent =		= rTorrent with ruTorrent =

			I exclusively use <code>ssh -N -L 8080:localhost:80 my.rtorrent.com</code> for accessing the web interface. In this case it is available at [http://localhost:8080]. Authentication and encryption is provided by SSH.

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">

Tie-ling: /* Control rtorrent with pyrosimple */ add warning for pyrosimple

2026-11-01T21:50:25Z

Control rtorrent with pyrosimple: add warning for pyrosimple

← Older revision		Revision as of 21:50, 1 November 2026
Line 258:		Line 258:

	Further documentation on pyrosimple can be found on its website https://kannibalox.github.io/pyrosimple/		Further documentation on pyrosimple can be found on its website https://kannibalox.github.io/pyrosimple/

			Warning: Do not use configuration generated by pyrosimple, the result is incompatible with latest rtorrent versions. See for example https://github.com/kannibalox/pyrosimple/issues/80
	[[Category:Server]]		[[Category:Server]]

Tie-ling: /* Control rtorrent with pyrosimple */ nowiki for single quotes

2026-11-01T21:46:32Z

Control rtorrent with pyrosimple: nowiki for single quotes

← Older revision		Revision as of 21:46, 1 November 2026
Line 244:		Line 244:
	nix-shell -p pyrosimple jq		nix-shell -p pyrosimple jq
	rtxmlrpc --output-format json -U scgi+unix:///run/rtorrent/rpc.sock \		rtxmlrpc --output-format json -U scgi+unix:///run/rtorrent/rpc.sock \
	d.multicall '' default d.name= > torrent_list.json		d.multicall <nowiki>''</nowiki> default d.name= > torrent_list.json

	Use jq to extract file names		Use jq to extract file names

Tie-ling: pyrosimple

2026-11-01T21:44:31Z

pyrosimple

← Older revision		Revision as of 21:44, 1 November 2026
Line 235:		Line 235:
	</syntaxhighlight>		</syntaxhighlight>

			= Control rtorrent with pyrosimple =

			Pyrosimple is a collection of tools for working with rTorrent. With pyrosimple, you can do everything ranging from making low-level RPC calls, to running a full-fledged daemon that will manage rTorrent according to user-defined rules.

			It has not been updated since early 2025, so there are compatibility issues with latest rTorrent versions. However, it is still useful for performing operations with rTorrent. An example is pruning orphaned torrents, i.e., torrents that are removed from rTorrent but still occupy disk space.

			We first generate a sorted list of torrents currently registered in rTorrent
			nix-shell -p pyrosimple jq
			rtxmlrpc --output-format json -U scgi+unix:///run/rtorrent/rpc.sock \
			d.multicall '' default d.name= > torrent_list.json

			Use jq to extract file names
			jq -r '.[].[0]' torrent_list.json \| sort > torrent_list_sorted.txt

			Generate a list of files currently on disk
			find /var/lib/rtorrent/download/ -mindepth 1 \
			-maxdepth 1 -type d -printf "%f\n" \
			\| sort > torrent_list_on_disk_sorted.txt

			Then compare the results
			diff torrent_list_on_disk_sorted.txt torrent_list_sorted.txt

			Further documentation on pyrosimple can be found on its website https://kannibalox.github.io/pyrosimple/
	[[Category:Server]]		[[Category:Server]]

Tie-ling: /* Use customized rtorrent.rc */ modernize

2026-11-01T21:23:43Z

Use customized rtorrent.rc: modernize

← Older revision		Revision as of 21:23, 1 November 2026
Line 183:		Line 183:
	{ pkgs, lib, config, ... }:		{ pkgs, lib, config, ... }:
	{		{
			# inessential comments pruned, see
			# https://github.com/rakshasa/rtorrent/blob/master/doc/rtorrent.rc-example
			# for commented configuration
			# https://raw.githubusercontent.com/NixOS/nixpkgs/refs/heads/nixos-26.05/nixos/modules/services/torrent/rtorrent.nix
	services.rtorrent.configText = lib.mkForce ''		services.rtorrent.configText = lib.mkForce ''
	~~# inessential comments pruned, see~~
	~~# https://github.com/rakshasa/rtorrent/blob/master/doc/rtorrent.rc-example~~
	~~# for commented configuration~~

	# prefer ipv6, allow ipv4		# prefer ipv6, allow ipv4
	network.prefer.ipv6.set = true		network.prefer.ipv6.set = true

	# Instance layout (base paths)		# Instance layout (base paths)
	method.insert = cfg.basedir, private\|const\|string, (cat,"~~/var/lib/~~rtorrent/")		method.insert = cfg.basedir, private\|const\|string, (cat,"${config.services.rtorrent.dataDir}/")
	method.insert = cfg.logs, private\|const\|string, (cat,(cfg.basedir),"log/")		method.insert = cfg.logs, private\|const\|string, (cat,(cfg.basedir),"log/")
	method.insert = cfg.logfile, private\|const\|string, (cat,(cfg.logs),(system.time),".log")		method.insert = cfg.logfile, private\|const\|string, (cat,(cfg.logs),(system.time),".log")
	method.insert = cfg.rpcsock, private\|const\|string, (cat,"${config.services.rtorrent.rpcSocket}")		method.insert = cfg.rpcsock, private\|const\|string, (cat,"${config.services.rtorrent.rpcSocket}")
	method.insert = cfg.download, private\|const\|string, (cat,(cfg.basedir),"download/")		method.insert = cfg.download, private\|const\|string, (cat,(cfg.basedir),"download/")
	execute.throw = sh, -c, (cat, "mkdir -p ", (cfg.basedir), "/session ", (cfg.logs), " ", (cfg.download)~~, " "~~)		execute.throw = sh, -c, (cat, "mkdir -p ", (cfg.basedir), "/session ", (cfg.logs), " ", (cfg.download))

	# erase torrent data when the torrent is deregistered from rtorrent		# erase torrent data when the torrent is deregistered from rtorrent
Line 207:		Line 207:
	execute.nothrow = sh, -c, (cat, "echo >", (session.path), "rtorrent.pid", " ", (system.pid))		execute.nothrow = sh, -c, (cat, "echo >", (session.path), "rtorrent.pid", " ", (system.pid))
	network.listen.port.random.set = no		network.listen.port.random.set = no
	network.listen.port.range.set = ~~51413~~-~~51413~~		network.listen.port.range.set = ${toString config.services.rtorrent.port}-${toString config.services.rtorrent.port}
	network.xmlrpc.size_limit.set = 8M		network.xmlrpc.size_limit.set = 8M
	pieces.hash.on_completion.set = no		pieces.hash.on_completion.set = no
Line 224:		Line 224:

	# XMLRPC		# XMLRPC
	~~scgi_local~~ = (cfg.rpcsock)		network.scgi.open_local = (cfg.rpcsock)
	~~schedule = scgi_permission,0,0,"~~execute.nothrow=chmod,770,(cfg.rpcsock)"		execute.nothrow = chmod,770,(cfg.rpcsock)

	# zfs supports basic fallocate to prevent fragmentation		# zfs supports basic fallocate to prevent fragmentation