Update readme and config

README.md

@@ -1,6 +1,18 @@
-# zurg-testing
+# zurg
 
-A self-hosted Real-Debrid webdav server written from scratch, alternative to rclone_rd. Together with [rclone](https://rclone.org/) it can mount your Real-Debrid torrent library into your filesystem.
+A self-hosted Real-Debrid webdav server written from scratch. Together with [rclone](https://rclone.org/) it can mount your Real-Debrid torrent library into your filesystem just like Dropbox.
+
+## Download
+
+### Latest version: v0.9.2-hotfix.4
+
+[Download the binary](https://github.com/debridmediamanager/zurg-testing/tree/main/releases/v0.9.2-hotfix.4) or use docker
+
+```sh
+docker pull ghcr.io/debridmediamanager/zurg-testing:latest
+# or
+docker pull ghcr.io/debridmediamanager/zurg-testing:v0.9.2-hotfix.4
+```
 
 ## How to run zurg in 5 steps for Plex
 
@@ -17,6 +29,13 @@ A webdav server is also exposed to your localhost via port `9999`.
 - Better performance than anything out there; changes in your library appear instantly (assuming Plex picks it up fast enough)
 - You should be able to access every file even if the torrent names are the same so if you have a lot of these, you might notice that zurg will have more files compared to others (e.g. 2 torrents named "Simpsons" but have different seasons, zurg merges all contents in that directory)
 - You can configure a flexible directory structure in `config.yml`; you can select individual torrents that should appear on a directory by the ID you see in [DMM](https://debridmediamanager.com/).
-- If you've ever experienced Plex scanner being stuck on a file and thereby freezing Plex completely, it should not happen anymore because zurg does a comprehensive check if a torrent is dead or not
+- If you've ever experienced Plex scanner being stuck on a file and thereby freezing Plex completely, it should not happen anymore because zurg does a comprehensive check if a torrent is dead or not. You can run `ps aux --sort=-time | grep "Plex Media Scanner"` to check for stuck scanner processes.
+
+## Guides
+
+- [@I-am-PUID-0](https://github.com/I-am-PUID-0) - [pd_zurg](https://github.com/I-am-PUID-0/pd_zurg)
+- [@Pukabyte](https://github.com/Pukabyte) - [Guide: Zurg + RDT + Prowlarr + Arrs + Petio + Autoscan + Plex + Scannarr](https://puksthepirate.notion.site/Guide-Zurg-RDT-Prowlarr-Arrs-Petio-Autoscan-Plex-Scannarr-eebe27d130fa400c8a0536cab9d46eb3)
 
 ## Please read our [wiki](https://github.com/debridmediamanager/zurg-testing/wiki) for more information!
+
+## [zurg's version history](https://github.com/debridmediamanager/zurg-testing/wiki/History)

config.example.yml

@@ -11,8 +11,10 @@ check_for_changes_every_secs: 15
 # misc configs
 retain_folder_name_extension: false # if true, zurg won't modify the filenames from real-debrid
 retain_rd_torrent_name: false # if true, it will strictly follow RD API torrent name property w/c should make this more compatible with rdt-client
-
+auto_delete_rar_torrents: false # if true, zurg will delete unstreamable rar files (these torrents will always be compressed in a rar archive no matter what files you select)
+use_download_cache: true # if true, during zurg initialization, it will fetch all downloads to unrestrict links faster
 enable_repair: true # BEWARE! THERE CAN ONLY BE 1 INSTANCE OF ZURG THAT SHOULD REPAIR YOUR TORRENTS
+# on_library_update: sh plex_update.sh "$@"
 on_library_update: |
   for arg in "$@"
   do
@@ -21,9 +23,9 @@ on_library_update: |
 
 # network configs
 network_buffer_size: 1048576 # 1 MiB
-serve_from_rclone: false # serve file data from rclone, not from zurg
+serve_from_rclone: false # serve file data from rclone, not from zurg (zurg will only provide rclone the link to download)
+verify_download_link: true # if true, zurg will check if the link is truly streamable; only relevant if serve_from_rclone is set to true (as it already does this all the time if serve_from_rclone is false)
 force_ipv6: false # force connect to real-debrid ipv6 addresses
-# reliability configs
 rate_limit_sleep_secs: 6 # wait time after getting a 429 from Real-Debrid API
 realdebrid_timeout_secs: 60 # api timeout
 retries_until_failed: 5 # api failures until considered failed
@@ -59,5 +61,6 @@ directories:
   movies:
     group: media  # because anime, shows and movies are in the same group,
     group_order: 30 # and anime and shows has a lower group_order number than movies, all torrents that doesn't fall into the previous 2 will fall into movies
+    only_show_the_biggest_file: true # let's not show the other files besides the movie itself
     filters:
       - regex: /.*/ # you cannot leave a directory without filters because it will not have any torrents in it