diff --git a/CONFIG-Template.md b/CONFIG-Template.md index df323bd..bae159d 100644 --- a/CONFIG-Template.md +++ b/CONFIG-Template.md @@ -45,7 +45,8 @@ from files in a ``config.d`` directory. # for an up-to-date version. ############################################################################# -# Instance layout (base paths) + +## Instance layout (base paths) method.insert = cfg.basedir, private|const|string, (cat,"/home/USERNAME/rtorrent/") method.insert = cfg.download, private|const|string, (cat,(cfg.basedir),"download/") method.insert = cfg.logs, private|const|string, (cat,(cfg.basedir),"log/") @@ -53,7 +54,8 @@ method.insert = cfg.logfile, private|const|string, (cat,(cfg.logs),"rtorrent-", method.insert = cfg.session, private|const|string, (cat,(cfg.basedir),".session/") method.insert = cfg.watch, private|const|string, (cat,(cfg.basedir),"watch/") -# Create instance directories + +## Create instance directories execute.throw = sh, -c, (cat,\ "mkdir -p \"",(cfg.download),"\" ",\ "\"",(cfg.logs),"\" ",\ @@ -61,17 +63,20 @@ execute.throw = sh, -c, (cat,\ "\"",(cfg.watch),"/load\" ",\ "\"",(cfg.watch),"/start\" ") -# Listening port for incoming peer traffic (fixed; you can also randomize it) + +## Listening port for incoming peer traffic (fixed; you can also randomize it) network.port_range.set = 50000-50000 network.port_random.set = no -# Tracker-less torrent and UDP tracker support -# (conservative settings for 'private' trackers, change for 'public') + +## Tracker-less torrent and UDP tracker support +## (conservative settings for 'private' trackers, change for 'public') dht.mode.set = disable protocol.pex.set = no trackers.use_udp.set = no -# Peer settings + +## Peer settings throttle.max_uploads.set = 100 throttle.max_uploads.global.set = 250 @@ -83,40 +88,45 @@ trackers.numwant.set = 80 protocol.encryption.set = allow_incoming,try_outgoing,enable_retry -# Limits for file handle resources, this is optimized for -# an `ulimit` of 1024 (a common default). You MUST leave -# a ceiling of handles reserved for rTorrent's internal needs! + +## Limits for file handle resources, this is optimized for +## an `ulimit` of 1024 (a common default). You MUST leave +## a ceiling of handles reserved for rTorrent's internal needs! network.http.max_open.set = 50 network.max_open_files.set = 600 network.max_open_sockets.set = 300 -# Memory resource usage (increase if you have a large number of items loaded, -# and/or the available resources to spend) + +## Memory resource usage (increase if you have a large number of items loaded, +## and/or the available resources to spend) pieces.memory.max.set = 1800M network.xmlrpc.size_limit.set = 4M -# Basic operational settings (no need to change these) + +## Basic operational settings (no need to change these) session.path.set = (cat, (cfg.session)) directory.default.set = (cat, (cfg.download)) log.execute = (cat, (cfg.logs), "execute.log") -##log.xmlrpc = (cat, (cfg.logs), "xmlrpc.log") +#log.xmlrpc = (cat, (cfg.logs), "xmlrpc.log") execute.nothrow = sh, -c, (cat, "echo >",\ (session.path), "rtorrent.pid", " ", (system.pid)) -# Other operational settings (check & adapt) + +## Other operational settings (check & adapt) encoding.add = utf8 system.umask.set = 0027 system.cwd.set = (directory.default) network.http.dns_cache_timeout.set = 25 schedule2 = monitor_diskspace, 15, 60, ((close_low_diskspace, 1000M)) -##pieces.hash.on_completion.set = no -##view.sort_current = seeding, greater=d.ratio= -##keys.layout.set = qwerty -##network.http.capath.set = "/etc/ssl/certs" -##network.http.ssl_verify_peer.set = 0 -##network.http.ssl_verify_host.set = 0 +#pieces.hash.on_completion.set = no +#view.sort_current = seeding, greater=d.ratio= +#keys.layout.set = qwerty +#network.http.capath.set = "/etc/ssl/certs" +#network.http.ssl_verify_peer.set = 0 +#network.http.ssl_verify_host.set = 0 -# Some additional values and commands + +## Some additional values and commands method.insert = system.startup_time, value|const, (system.time) method.insert = d.data_path, simple,\ "if=(d.is_multi_file),\ @@ -124,23 +134,26 @@ method.insert = d.data_path, simple,\ (cat, (d.directory), /, (d.name))" method.insert = d.session_file, simple, "cat=(session.path), (d.hash), .torrent" -# Watch directories (add more as you like, but use unique schedule names) + +## Watch directories (add more as you like, but use unique schedule names) schedule2 = watch_start, 10, 10, ((load.start_verbose, (cat, (cfg.watch), "start/*.torrent"))) schedule2 = watch_load, 11, 10, ((load.verbose, (cat, (cfg.watch), "load/*.torrent"))) -# Run the rTorrent process as a daemon in the background -# (and control via XMLRPC sockets) -#system.daemon.set = true -#network.scgi.open_local = (cat,(session.path),rtorrent.sock) -#execute.nothrow = chmod,770,(cat,(session.path),rtorrent.sock) -# Logging: -# Levels = critical error warn notice info debug -# Groups = connection_* dht_* peer_* rpc_* storage_* thread_* tracker_* torrent_* +## Run the rTorrent process as a daemon in the background +## (and control via XMLRPC sockets) +#system.daemon.set = true +#network.scgi.open_local = (cat,(session.path),rpc.socket) +#execute.nothrow = chmod,770,(cat,(session.path),rpc.socket) + + +## Logging: +## Levels = critical error warn notice info debug +## Groups = connection_* dht_* peer_* rpc_* storage_* thread_* tracker_* torrent_* print = (cat, "Logging to ", (cfg.logfile)) log.open_file = "log", (cfg.logfile) log.add_output = "info", "log" -##log.add_output = "tracker_debug", "log" +#log.add_output = "tracker_debug", "log" ### END of rtorrent.rc ### ``` \ No newline at end of file