chris/Axter-Stash
1
0
Fork 0
forked from Github/Axter-Stash
Code Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
David Maisonave
2025-01-09 13:51:45 -05:00
committed by GitHub
parent e767f05b0b
commit 1ce7b3b97c
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
plugins/FileMonitor/README.md
View File

@@ -189,6 +189,8 @@ Please use the following link to report FileMonitor Feature Request:[FileMonitor
Please do **NOT** use the feature request to include any problems associated with errors. Instead use the bug report for error issues. Please do **NOT** use the feature request to include any problems associated with errors. Instead use the bug report for error issues.
## Docker ## Docker
### Single Stash Docker Installation
- **Note:** This section is for users who have a single instance of Stash Docker installed, and do NOT have Stash installed on the host machine.
- FileMonitor requires watchdog module in order to work. Although the watchdog module loads and runs on Docker, it fails to function because Docker fails to report file changes. - FileMonitor requires watchdog module in order to work. Although the watchdog module loads and runs on Docker, it fails to function because Docker fails to report file changes.
- FileMonitor can work with Docker Stash setup if it's executed externally on the host OS. Start FileMonitor on the command line and pass the Stash URL and --docker. - FileMonitor can work with Docker Stash setup if it's executed externally on the host OS. Start FileMonitor on the command line and pass the Stash URL and --docker.
- Example1: - Example1:
@@ -201,8 +203,11 @@ python filemonitor.py --url http://localhost:9999 --docker "C:\Users\MyUser\AppD
``` ```
- The **docker-compose.yml** file should be located in the folder associated with the Docker Stash container, and it list the mapped paths which FileMonitor uses to determine the host path which is mapped to the Docker path. - The **docker-compose.yml** file should be located in the folder associated with the Docker Stash container, and it list the mapped paths which FileMonitor uses to determine the host path which is mapped to the Docker path.
- For more information, see [Using FileMonitor as a script](https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/FileMonitor#Using-FileMonitor-as-a-script) - For more information, see [Using FileMonitor as a script](https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/FileMonitor#Using-FileMonitor-as-a-script)
- For more information on creating a Docker Stash setup, see - For more information on creating a Docker Stash setup, see (https://github.com/David-Maisonave/Axter-Stash/tree/main/Docker)
(https://github.com/David-Maisonave/Axter-Stash/tree/main/Docker) ### Multiple Stash Docker Configuration
- **Note:** This section applies to users who have multiple Stash Docker instances running, and also have Stash installed and running on the host machine as well.
- FileMonitor can be configured to run on the host machine, and update all the Stash Docker instances when a file change occurs. To activate this option change the filemonitor_config.py file by setting the **dockers** field with the information associated with each Stash Docker instance.
- There are three examples which are commented out in the **dockers** field, which users can easily modify to configure for thier particular Stash Docker instances.
### Future Planned Features or Fixes ### 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. - 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.