diff --git a/README.md b/README.md new file mode 100644 index 0000000..1c460c4 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# SXP Service Watcher + +This program allows to automatically restart the SXP service provided by GSD Software by **observing** the log directory of the SXP service. +If the SXP service is stuck, then log files of a specific type are being created that can be used as an indicator that the service is hanging. + +## Configuration +The configuration file **MUST** be within the same folder as the executable. + +1. `period` is given as seconds and determines the interval in which the destination log folder is checked. Default: 30 seconds. +2. `watch_dir` and `dir` **MUST** be absolute +3. `service_name` is the name of the target service to be restarted +4. `watch_file_prefix` is the prefix of the log files that are created by the SXP service +5. `watch_file_size` is the size in kB of the created log files to be checked. Default: 0 kB + + +## Installation +This program is written as a windows service that can be registered by using the script `register.ps1`. + +**Steps**: +1. Move the built target executable along with the configuration file `config.toml` and `register.ps1` to your desired destination folder. +2. Start PowerShell as **Administrator** +3. Navigate to the folder of step 1. +4. Configure **config.toml** +5. Run `./register.ps1` within opened PowerShell of Step 1 + +## Error handling +A log file called `sv_file_watcher.log` is created in the same path as the executable. Use the content of this log file to communicate errors. \ No newline at end of file