clarify remote_dir usage (#417)

StuffAnThings · Oct 13, 2023 · b97cdcc · b97cdcc
1 parent 9290d2c
commit b97cdcc
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/config/config.yml.sample b/config/config.yml.sample
@@ -38,7 +38,8 @@ directory:
   # Cross-seed var: </your/path/here/>  # Output directory of cross-seed
   # root_dir var: </your/path/here/>  # Root downloads directory used to check for orphaned files, noHL, and RecycleBin.
   # <OPTIONAL> remote_dir var: </your/path/here/>  # Path of docker host mapping of root_dir.
-  # Must be set if you're running qbit_manage locally and qBittorrent/cross_seed is in a docker
+  # remote_dir must be set if you're running qbit_manage locally and qBittorrent/cross_seed is in a docker
+  # remote_dir should not be set if qbit_manage is running in a container
   # <OPTIONAL> recycle_bin var: </your/path/here/>   # Path of the RecycleBin folder. Default location is set to remote_dir/.RecycleBin
   # <OPTIONAL> torrents_dir var: </your/path/here/>  # Path of the your qbittorrent torrents directory. Required for `save_torrents` attribute in recyclebin
   # <OPTIONAL> orphaned_dir var: </your/path/here/>  # Path of the the Orphaned Data folder. This is similar to RecycleBin, but only for orphaned data.