Merge pull request #64 from bakerboy448/patch-2

various fixes

config/config.yml.sample

@@ -1,3 +1,6 @@
+# This is an example configuration file that documents all the options.
+# It will need to be modified for your specific use case.
+
 # qBittorrent parameters
 qbt:
   host: "localhost:8080"
@@ -6,17 +9,17 @@ qbt:
 
 directory:
   # Do not remove these
-  # Cross-seed var: </your/path/here/> #Output directory of cross-seed
+  # 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.
+  # 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
+  # Must be set if you're running qbit_manage locally and qBittorrent/cross_seed is in a docker
   cross_seed: "/your/path/here/"
   root_dir: "/data/torrents/"
   remote_dir: "/mnt/user/data/torrents/"
 
-# Category/Pathing Parameters
+# Category & Path Parameters
 cat:
-  # <Category Name> : <save_path> #Path of your save directory. Can be a keyword or full path
+  # <Category Name> : <save_path> # Path of your save directory. Can be a keyword or full path
   movies: "/data/torrents/Movies"
   tv: "TV"
 
@@ -53,6 +56,7 @@ tags:
   digitalcore:
     tag: DigitalCore
     max_ratio: 5.0
+    notifiarr: digitalcore
   gazellegames:
     tag: GGn
     limit_upload_speed: 150
@@ -72,75 +76,79 @@ tags:
     notifiarr:
   tleechreload:
     tag: TorrentLeech
+    notifiarr: torrentleech
   torrentdb:
     tag: TorrentDB
+    notifiarr: torrentdb
   torrentleech:
     tag: TorrentLeech
+    notifiarr: torrentleech
   tv-vault:
     tag: TV-Vault
 
-
+# Tag Movies/Series that are not hard linked
-#Tag Movies/Series that are not hard linked
 nohardlinks:
   # Mandatory to fill out directory parameter above to use this function (root_dir/remote_dir)
   # This variable should be set to your category name of your completed movies/completed series in qbit. Acceptable variable can be any category you would like to tag if there are no hardlinks found
   movies-completed:
-    #<OPTIONAL> exclude_tags var: Will exclude the following tags when searching through the category.
+    # <OPTIONAL> exclude_tags var: Will exclude the following tags when searching through the category.
     exclude_tags:
       - Beyond-HD
       - AnimeBytes
       - MaM
-    #<OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that are in paused state and has the NoHL tag
+    # <OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that are in paused state and has the NoHL tag
     cleanup: false
-    #<OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading
+    # <OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading
     max_ratio: 4.0
-    #<OPTIONAL> seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding
+    # <OPTIONAL> seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding
     max_seeding_time: 86400
 
-  #Can have additional categories set with separate ratio/seeding times defined.
+  # Can have additional categories set with separate ratio/seeding times defined.
   series-completed:
-    #<OPTIONAL> exclude_tags var: Will exclude the following tags when searching through the category.
+    # <OPTIONAL> exclude_tags var: Will exclude the following tags when searching through the category.
     exclude_tags:
       - Beyond-HD
       - BroadcasTheNet
-    #<OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that are in paused state and has the NoHL tag
+    # <OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that are in paused state and has the NoHL tag
     cleanup: false
-    #<OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading
+    # <OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading
     max_ratio: 4.0
-    #<OPTIONAL> seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding
+    # <OPTIONAL> seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding
     max_seeding_time: 86400
 
-#Recycle Bin method of deletion will move files into the recycle bin (Located in /root_dir/.RecycleBin) instead of directly deleting them in qbit
+# Recycle Bin method of deletion will move files into the recycle bin (Located in /root_dir/.RecycleBin) instead of directly deleting them in qbit
-#By default the Recycle Bin will be emptied on every run of the qbit_manage script if empty_after_x_days is defined.
+# By default the Recycle Bin will be emptied on every run of the qbit_manage script if empty_after_x_days is defined.
 recyclebin:
   enabled: true
-  #<OPTIONAL> empty_after_x_days var: Will automatically remove all files and folders in recycle bin after x days. (Checks every script run)
+  # <OPTIONAL> empty_after_x_days var: Will automatically remove all files and folders in recycle bin after x days. (Checks every script run)
   #                                   If this variable is not defined it, the RecycleBin will never be emptied.
   #                                   WARNING: Setting this variable to 0 will delete all files immediately upon script run!
   empty_after_x_days: 60
 
 # Orphaned files are those in the root_dir download directory that are not referenced by any active torrents.
 orphaned:
-    # File patterns that will not be considered orphaned files. Handy for generated files that aren't part of the torrent but belong with the torrent's files
+  # File patterns that will not be considered orphaned files. Handy for generated files that aren't part of the torrent but belong with the torrent's files
-    exclude_patterns:
+  exclude_patterns:
-        - "**/.DS_Store"
+    - "**/.DS_Store"
-        - "**/Thumbs.db"
+    - "**/Thumbs.db"
-        - "**/@eaDir"
+    - "**/@eaDir"
-        - "/data/torrents/temp/**"
+    - "/data/torrents/temp/**"
-        - "**/*.!qB"
+    - "**/*.!qB"
 
-#Apprise integration with webhooks
+# Apprise integration with webhooks
+# Leave Empty/Blank to disable
 apprise:
-  #Mandatory to fill out the url of your apprise API endpoint
+  # Mandatory to fill out the url of your apprise API endpoint
   api_url: http://apprise-api:8000
-  #Mandatory to fill out the notification url/urls based on the notification services provided by apprise. https://github.com/caronc/apprise/wiki
+  # Mandatory to fill out the notification url/urls based on the notification services provided by apprise. https://github.com/caronc/apprise/wiki
   notify_url:
 
-#Notifiarr integration with webhooks
+# Notifiarr integration with webhooks
+# Leave Empty/Blank to disable
 notifiarr:
-  #Mandatory to fill out API Key
+  # Mandatory to fill out API Key
   apikey: ####################################
-  #<OPTIONAL> Set to a unique value (could be your username on notifiarr for example)
+  # <OPTIONAL> Set to a unique value (could be your username on notifiarr for example)
   instance:
 
 # Webhook notifications:
@@ -148,6 +156,7 @@ notifiarr:
 # Set value to notifiarr if using notifiarr integration
 # Set value to apprise if using apprise integration
 # Set value to a valid webhook URL
+# Leave Empty/Blank to disable
 webhooks:
   error: https://mywebhookurl.com/qbt_manage
   run_start: notifiarr