Update readme files

David-Maisonave · David-Maisonave · commit b789156af090 · 2025-09-06T23:41:40.000-04:00
diff --git a/plugins/DupFileManager/README.md b/plugins/DupFileManager/README.md
@@ -2,19 +2,29 @@
 
 https://discourse.stashapp.cc/t/dupfilemanager/1331
 
-### Note: 
-The author of this plugin does **not** monitor Discourse. Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
-The Discourse link should be use for discussion that would be inappropriate in GitHub.
+Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
 
 
 DupFileManager is a [Stash](https://github.com/stashapp/stash) plugin which manages duplicate files in the Stash system.
 It has both **task** and **tools-UI** components.
 
+## Content
+- [Features](#Features)
+- [Requirements](#Requirements)
+- [Installation](#Installation)
+- [Options](#Options)
+- [Advanced Options](#Advanced-Options)
+- [Future Planned Features, Changes, or Fixes](#Future-Planned-Features-Changes-or-Fixes)
+- [Stash Password](#Stash-Password)
+- [Screenshots](#Screenshots)
+- [Discourse](#Discourse)
+
+
 ### Features
 
-- Creates a duplicate file report which can be accessed from the settings->tools menu options.The report is created as an HTML file and stored in local path under plugins\DupFileManager\report\DuplicateTagScenes.html.
+- Creates a duplicate file report which can be accessed from the Stash->Settings->Tools menu options. The report is created as an HTML file and stored in local path under plugins\DupFileManager\report\DuplicateTagScenes.html.
   - See screenshot at the bottom of this page for example report.
-  - Items on the left side of the report are the primary duplicates designated for deletion. By default, these duplicates are given a special \_duplicate tag.
+  - Items on the left side of the report are the primary duplicates designated for deletion. By default, these duplicates are given a special _duplicate tag.
   - Items on the right side of the report are designated as primary duplicates to keep. They usually have higher resolution, duration and/or preferred paths.
   - The report has the following options:
     - Delete: Delete file and remove from Stash library.
@@ -29,12 +39,11 @@ It has both **task** and **tools-UI** components.
     - Merge: Copy Metadata (tags, performers,& studios) from left to right.
 - Can merge potential source in the duplicate file names for tag names, performers, and studios.
   - Normally when Stash searches the file name for tag names, performers, and studios, it only does so using the primary file.
-- Advance menu (for specially tagged duplicates)
-  ![Screenshot 2024-11-22 145139](https://github.com/user-attachments/assets/d76646f0-c5a8-4069-ad0f-a6e5e96e7ed0)
-  - Advance menu can be access from the Settings->Tools->**[DupFileManager Tools and Utilities]** menu or from the **reports**.
-    - Only access Advance Menu from the report when using Stash setup requiring a password.
+- Advance menu
+  - ![Screenshot 2024-12-13 164930](https://github.com/user-attachments/assets/10098a4d-de2f-4e83-94ce-5988c5935404)
+  - Advance menu can be access from the Stash->Settings->Tools->**[Duplicate File Report]** menu or from the **DupFileManager Tools & Util**.
   - Here are **some** of the options available in the **Advance Menu**.
-    - Delete only specially tagged duplicates in blacklist path.
+    - Delete specially tagged duplicates in blacklist path.
     - Delete duplicates with specified file path.
     - Delete duplicates with specific string in File name.
     - Delete duplicates with specified file size range.
@@ -43,14 +52,14 @@ It has both **task** and **tools-UI** components.
     - Delete duplicates having specified tags.
     - Delete duplicates with specified rating.
     - Delete duplicates with any of the above combinations.
-- Bottom extended portion of the Advanced Menu screen.
-  - ![Screenshot 2024-11-22 232005](https://github.com/user-attachments/assets/9a0d2e9d-783b-4ea2-8fa5-3805b40af4eb)
+- Bottom extended portion of the Advanced Menu is for customizing the report.
+  - ![Screenshot 2025-01-14 141032](https://github.com/user-attachments/assets/a37e2074-cfec-47ae-9eed-a7769fc2245d)
 - Delete duplicate file task with the following options:
-  - Tasks (Settings->Task->[Plugin Tasks]->DupFileManager)
+  - Tasks (Stash->Settings->Task->[Plugin Tasks]->DupFileManager)
     - **Tag Duplicates** - Set tag DuplicateMarkForDeletion to the duplicates with lower resolution, duration, file name length, and/or black list path.
     - **Delete Tagged Duplicates** - Delete scenes having DuplicateMarkForDeletion tag.
     - **Delete Duplicates** - Deletes duplicate files. Performs deletion without first tagging.
-  - Plugin UI options (Settings->Plugins->Plugins->[DupFileManager])
+  - Plugin UI options (Stash->Settings->Plugins->Plugins->[DupFileManager])
     - Has a 3 tier path selection to determine which duplicates to keep, and which should be candidates for deletions.
       - **Whitelist** - List of paths NOT to be deleted.
         - E.g. C:\Favorite\,E:\MustKeep\
@@ -88,8 +97,39 @@ That's it!!!
 
 ### Options
 
-- Options are accessible in the GUI via Settings->Plugins->Plugins->[DupFileManager].
-- More options available in DupFileManager_config.py.
+- Options are accessible in the GUI via Stash->Settings->Plugins->Plugins->[DupFileManager].
+- Also see:
+  - Stash->Settings->Tools->[Duplicate File Report]
+  - Stash->Settings->Tools->[DupFileManager Tools and Utilities]
+- More options available on the following link:
+  - [advance_options.html](https://stash.axter.com/1.1/advance_options.html)
+  - When using a Stash installation that requires a password or that is not using port 9999...
+    - Access above link from Stash->Settings->Tools->[Duplicate File Report]->[**Advance Duplicate File Menu**]
+	- Or add the GQL and apiKey as parameters to the URL.
+	  - Example: https://stash.axter.com/1.1/advance_options.html?GQL=http://localhost:9999/graphql&apiKey=1234567890abcdefghijklmnop
+    - See following for more details: [Stash Password](README.md#Stash-Password)
+
+### Advanced Options
+
+Users can setup a private or alternate remote site by changing variables **remoteReportDirURL** and **js_DirURL** in file DupFileManager_report_config.py.
+- The following files are needed at the remote site that is pointed to by **remoteReportDirURL**.
+  - DupFileManager_report.js
+  - DupFileManager_report.css
+  - file.html
+  - advance_options.html
+- The **js_DirURL** path requires the following:
+  - jquery-3.7.1.min.js
+  - EasyUI associated files
+  - jquery.prompt.js and jquery.prompt.css  
+
+### Stash Password
+
+- Stash installation configured with a password, need to generate an API-Key. 
+  - To generate an API-Key:
+    - Go to Stash->Settings->Security->Authentication->[API Key]
+	- Click on [Generate API-Key]
+- Once the API key is generated, DupFileManager will automatically fetch the key.
+
 
 ### Screenshots
 
@@ -98,7 +138,7 @@ That's it!!!
   - ![Screenshot 2024-11-22 225359](https://github.com/user-attachments/assets/dc705b24-e2d7-4663-92fd-1516aa7aacf5)
   - If there's a scene on the left side that has a higher resolution or duration, it gets a yellow highlight on the report.
   - There's an optional setting that allows both preview videos and preview images to be displayed on the report. See settings **htmlIncludeImagePreview** in the **DupFileManager_report_config.py** file.
-  - There are many more options available for how the report is created. These options are targeted for more advanced users. The options are all available in the **DupFileManager_report_config.py** file, and the settings have commented descriptions preceeding them. See the **DupFileManager_report_config.py** file in the DupFileManager plugin folder for more details.
+  - There are many more options available for how the report is created. These options are targeted for more advanced users.  The options are all available in the **DupFileManager_report_config.py** file, and the settings have commented descriptions preceding them. See the **DupFileManager_report_config.py** file in the DupFileManager plugin folder for more details.
 - Tools UI Menu
   ![Screenshot 2024-11-22 145512](https://github.com/user-attachments/assets/03e166eb-ddaa-4eb8-8160-4c9180ca1323)
   - Can access either **Duplicate File Report (DupFileManager)** or **DupFileManager Tools and Utilities** menu options.
@@ -107,12 +147,40 @@ That's it!!!
 - DupFileManager Tools and Utilities
   - ![Screenshot 2024-11-22 152023](https://github.com/user-attachments/assets/4daaea9e-f603-4619-b536-e6609135bab1)
 - Full bottom extended portion of the Advanced Menu screen.
-  - ![Screenshot 2024-11-22 232208](https://github.com/user-attachments/assets/bf1f3021-3a8c-4875-9737-60ee3d7fe675)
-
-### Future Planned Features
+  - ![Screenshot 2025-01-14 141613](https://github.com/user-attachments/assets/77928538-e6f2-47b7-8717-45db054ffbf5)
+
+### Future Planned Features, Changes, or Fixes
+- Scheduled Changes
+  - On Adv Menu, add option to set special _ToBeDeletedTag_ under Delete button menu.
+  - Remove [Max Dup Process] from the Stash->Plugins GUI. This option already exist in advance menu. Planned for 1.2.0 Version.
+  - Add chat icon to report which on hover, displays a popup window showing scene details content. Planned for 1.2.0 Version.
+  - Add studio icon to report; on hover show studio name. Planned for 1.2.0 Version.
+  - Add option on report to view rating and change it. Use an icon with a number on it to show rating. Planned for 1.2.0 Version.
+  - On report make flag toggle logic. In other words, when flag button is selected, and scene is already that color, remove the colored flag. Planned for 1.2.0 Version.
+  - Add report option to set flag to all scenes missing metadata on Scene-ToKeep or having higher resolution or longer duration on **Duplicate-to-Delete** scene. Planned for 1.2.0 Version.
+  - Add option to [**Advance Duplicate File Menu**] to display cover image for preview image. Planned for 1.2.0 Version.
+  - On report, when move operation is performed, have it automatically delete the **Duplicate-to-Delete** scene. Planned for 1.2.0 Version.
+  - On [**Advance Duplicate File Menu**], add a flag option to the menu on the left side, and shrink the tag option. Planned for 1.2.0 Version.
+    - Change the TagOrFlag option on the right side to a check mark.
+  - Add option to delete by file type. Planned for 1.2.0 Version.
+  - On report, have [Flag or Tag] option still enabled after manually disabling scene. Planned for 1.2.0 Version.
+  - On [**Advance Duplicate File Menu**], have the details section hide fully, or partially when the page is first displayed. Planned for 1.4.0 Version.
+- Unscheduled Changes
+  - Change splitbutton so it hides tooltip when hovering over dropdown side of the button.
+  - Fix errors on HTML page listed in https://validator.w3.org.
+  - Add logic to merge performers and galleries separately from tag merging on report.
+  - Add logic to merge group metadata when selecting merge option on report.
+  - Add advanced menu directly to the Stash->Settings->Tools menu. (This change does not look doable!!!)
+  - Add report directly to the Stash->Settings->Tools menu. (This change does not look doable!!!)
+  - Add double strike-through option to flagging.
+  - Add option to report to automatically strip width & height from name on rename. Example: foofoo - 1920x1080P.mp4
+  - Move [Merge Duplicate Tags], [Whitelist Delete In Same Folder], and [Swap Better **] field options from the Stash->Plugins GUI to the advance menu.
+    
+
+### Discourse
+[Discourse-DupFileManager](https://discourse.stashapp.cc/t/dupfilemanager/1331)
+
+**Note:**
+- The author of this plugin does **not** monitor Discourse. Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
+- The [Discourse link](https://discourse.stashapp.cc/t/dupfilemanager/1331) should be use for discussion that would be inappropriate in GitHub.
 
-- Add logic to merge performers and galaries seperatly from tag merging on report. Planned for 1.5.0 Version.
-- Add code to report to make it when the report updates the screen (due to tag merging), it stays in the same row position. Planned for 1.5.0 Version.
-- Add logic to merge group metadata when selecting merge option on report. Planned for 2.0.0 Version.
-- Add advanced menu directly to the Settings->Tools menu. Planned for 2.0.0 Version.
-- Add report directly to the Settings->Tools menu. Planned for 2.0.0 Version.
diff --git a/plugins/FileMonitor/README.md b/plugins/FileMonitor/README.md
@@ -2,15 +2,28 @@
 
 https://discourse.stashapp.cc/t/filemonitor/1333
 
-### Note: 
-The author of this plugin does **not** monitor Discourse. Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
-The Discourse link should be use for discussion that would be inappropriate in GitHub.
+Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
 
 FileMonitor is a [Stash](https://github.com/stashapp/stash) plugin with the following two main features:
 
 - Updates Stash when any file changes occurs in the Stash library.
 - **Task Scheduler**: Runs scheduled task based on the scheduler configuration in **filemonitor_config.py**.
 
+## Content
+- [Starting FileMonitor from the UI](#Starting-FileMonitor-from-the-UI)
+- [Using FileMonitor as a script](#Using-FileMonitor-as-a-script)
+- [Task Scheduler](#Task-Scheduler)
+- [Requirements](#Requirements)
+- [Installation](#Installation)
+- [Options](#Options)
+- [Docker](#Docker)
+  - [Single Stash Docker Installation](#Single-Stash-Docker-Installation)
+  - [Multiple Stash Docker Configuration](#Multiple-Stash-Docker-Configuration)
+  - [Stash Docker Installer](#Stash-Docker-Installer)
+- [Bugs and Feature Request](#Bugs-and-Feature-Request)
+  - [Future Planned Features or Fixes](#Future-Planned-Features-or-Fixes)
+- [Discourse](#Discourse)
+
 ## Starting FileMonitor from the UI
 
 From the GUI, FileMonitor can be started as a service or as a plugin. The recommended method is to start it as a service. When started as a service, it will jump on the Task Queue momentarily, and then disappear as it starts running in the background.
@@ -182,15 +195,6 @@ That's it!!!
   - The other options are self explanatory from the UI.
 - Additional options available in filemonitor_config.py. The options are well documented in the commented code.
 
-## Bugs and Feature Request
-
-Please use the following link to report FileMonitor bugs:
-[FileMonitor Bug Report](https://github.com/David-Maisonave/Axter-Stash/issues/new?assignees=&labels=Plugin_Bug&projects=&template=bug_report_plugin.yml&title=%F0%9F%AA%B2%5BFileMonitor%5D+Your_Short_title)
-
-Please use the following link to report FileMonitor Feature Request:[FileMonitor Feature Reques](https://github.com/David-Maisonave/Axter-Stash/issues/new?assignees=&labels=Enhancement&projects=&template=feature_request_plugin.yml&title=%F0%9F%92%A1%EF%B8%8F%5BEnhancement%5D%3A%5BFileMonitor%5D+Your_Short_title)
-
-Please do **NOT** use the feature request to include any problems associated with errors. Instead use the bug report for error issues.
-
 ## Docker
 
 ### Single Stash Docker Installation
@@ -272,6 +276,22 @@ python filemonitor.py --url http://localhost:9999 --docker "C:\Users\MyUser\AppD
 
 If you need help installing Stash Docker, use the Stash Docker installer in the following link: (https://github.com/David-Maisonave/Axter-Stash/tree/main/Docker)
 
-## Future Planned Features or Fixes
+## Bugs and Feature Request
 
+Please use the following link to report FileMonitor bugs:
+[FileMonitor Bug Report](https://github.com/David-Maisonave/Axter-Stash/issues/new?assignees=&labels=Plugin_Bug&projects=&template=bug_report_plugin.yml&title=%F0%9F%AA%B2%5BFileMonitor%5D+Your_Short_title)
+
+Please use the following link to report FileMonitor Feature Request:[FileMonitor Feature Reques](https://github.com/David-Maisonave/Axter-Stash/issues/new?assignees=&labels=Enhancement&projects=&template=feature_request_plugin.yml&title=%F0%9F%92%A1%EF%B8%8F%5BEnhancement%5D%3A%5BFileMonitor%5D+Your_Short_title)
+
+Please do **NOT** use the feature request to include any problems associated with errors. Instead use the bug report for error issues.
+
+### Future Planned Features or Fixes
 - Have the FileMonitor running status ICON update the icon without having to go to the Settings->Tools->FileMonitor page. Planned for version 1.2.0.
+
+### Discourse
+[Discourse-FileMonitor](https://discourse.stashapp.cc/t/filemonitor/1333)
+
+**Note:**
+- The author of this plugin does **not** monitor Discourse. Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
+- The [Discourse link](https://discourse.stashapp.cc/t/filemonitor/1333) should be use for discussion that would be inappropriate in GitHub.
+
diff --git a/plugins/RenameFile/README.md b/plugins/RenameFile/README.md
@@ -133,6 +133,6 @@ Please do **NOT** use the feature request to include any problems associated wit
 [Discourse-RenameFile](https://discourse.stashapp.cc/t/renamefile/1334)
 
 **Note:**
-The author of this plugin does **not** monitor Discourse. Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
-The Discourse link should be use for discussion that would be inappropriate in GitHub.
+- The author of this plugin does **not** monitor Discourse. Please post any (**G-Rated**) bugs, feature request, help-request to the following link: [Issues](https://github.com/David-Maisonave/Axter-Stash/issues/new/choose).
+- The [Discourse link](https://discourse.stashapp.cc/t/renamefile/1334) should be use for discussion that would be inappropriate in GitHub.
 
