Respect rtorrent config file

[rkdover]

Type: Bug Report

• [ x ] Try to follow the update procedure described in the README and try again before opening this issue.

Your Environment

• Version used:
  Docker (jesec/flood:latest, sha256:87259979d6ff581e463491475ccf22013775066e6c44c1051a88db8dd9644159)
• Operating system and version:
  Debian GNU/Linux 12 (bookworm) x86_64
• Torrent client and version:
  rtorrent/0.9.8/0.13.8

Summary

When starting flood, connected to a dockerized rtorrent, the default settings for flood are pushed onto rtorrent. E.g. DHT enabled, which port is open. With a setup that configures the listening port dynamically, this behavior in flood makes automation more difficult (and is arguably nonsensical).

Expected Behavior

Fetch current config from rtorrent and fill in the settings UI accordingly. Do not change torrent client settings without user request. If client settings have changed between flood sessions, respect those.

Current Behavior

Flood writes its own default settings to rtorrent on startup.

Possible Solution

Fetch client settings after connecting, save these to flood db.

Steps to Reproduce

docker-compose.yml:

services:
  flood:
    image: jesec/flood
    user: 1000:1000
    restart: always
    command: --auth=none --rtsocket /rtorrent/rtorrent.sock --host 0.0.0.0
    environment:
      HOME: /config
    volumes:
      - ./flood:/config/.local/share/flood
      - /data:/data
      - ./rtorrent:/rtorrent
  rtorrent:
    image: jesec/rtorrent:0.9.8-r16
    user: 1000:1000
    restart: always
    command: ["-o", "system.daemon.set=true"]
    environment:
      HOME: /config
    volumes:
      - ./rtorrent:/config/.local/share/rtorrent
      - /data:/data

example .rtorrent.rc:

## Import default configurations
import = /config/defaults_rtorrent.rc

# 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

# Memory resource usage (increase if you have a large number of items loaded,
# and/or the available resources to spend)
pieces.memory.max.set = 4000M
network.xmlrpc.size_limit.set = 32M

network.port_range.set = 44646-44646

# Write a PID file into the session directory
execute.throw = sh, -c, (cat, "echo >", (session.path), "rtorrent.pid", " ", (system.pid))

Following this example, both network.port_range and dht.mode will be set to the flood defaults. ("dht":true, networkPortRange":"6881-6999")

Context

Docker compose stack (gluetun+rtorrent+flood) that handles VPN providers with dynamically forwarded ports.

[trim21]

make sense

[rkdover]

make sense

Thanks! I tried to bodge together a fix with the flood api but my PATCH /api/client/settings calls seem ineffective. Is this a known bug or am I doing something wrong?

Example call and verification:

rkdover@tower-main: /data-fast/mediaserver/torrent_stack_1
$ curl "http://localhost:3001/api/client/settings" \                                                                                               [22:27:06]
  -X PATCH \
  -b cookie.txt \
  -d '{"dht":false,"directoryDefault":"/data/completed","networkPortOpen":false,"networkPortRandom":false,"networkPortRange":"39996-39996","protocolPex":false}' 
 
rkdover@tower-main: /data-fast/mediaserver/torrent_stack_1
$ curl http://localhost:3001/api/client/settings -b cookie.txt                                                                                     [22:27:45]
{"dht":true,"dhtPort":6881,"directoryDefault":"/config/.local/share/rtorrent/download/","networkHttpMaxOpen":50,"networkLocalAddress":[""],"networkMaxOpenFiles":600,"networkPortOpen":false,"networkPortRandom":false,"networkPortRange":"6881-6999","piecesHashOnCompletion":false,"piecesMemoryMax":1800,"protocolPex":true,"throttleGlobalDownSpeed":0,"throttleGlobalUpSpeed":0,"throttleMaxPeersNormal":60,"throttleMaxPeersSeed":80,"throttleMaxDownloads":50,"throttleMaxDownloadsGlobal":0,"throttleMaxUploads":100,"throttleMaxUploadsGlobal":250,"throttleMinPeersNormal":20,"throttleMinPeersSeed":30,"trackersNumWant":80}%                 

[rkdover]

Actually the interface doesn't update the port either. I found this out from connectivity tests on trackers. The interface saves and says "saved successfully" but the torrent client does not update. I honestly don't know how to troubleshoot this, or if it's specific to my setup... feels like this kind of thing would have been reported before.

[trim21]

not good, if users update their rtorrent config and restart both flood and rtorrent, we can't know what's the expected config users want.