diff --git a/README.md b/README.md index febe62ead72553a9cd2c7d6c9eb50e49f07258c1..ad74e1be8d6e37ed8894454b047aa2ad37d48e6c 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ licence: Free software GNU GPL 3.0 Source: https://git-repo.iml.unibe.ch/open-source/onfilechange - ## Installation * Copy the bash script somewhere you like. @@ -22,20 +21,20 @@ Source: https://git-repo.iml.unibe.ch/open-source/onfilechange ``` Parameters - -c [command] - command to execute on a file change - -f [filename(s)] - filenames to watch; separate multiple files with space and put all in quotes - -h - show this help - -i - force inotifywait command - -s - force stats command - -v - verbose mode; enable showing debug output - -w [integer] - for stats mode: wait time in seconds betweeen each test or on missing file; default: 5 sec + -c [command] + command to execute on a file change + -f [filename(s)] + filenames to watch; separate multiple files with space and put all in quotes + -h + show this help + -i + force inotifywait command + -s + force stats command + -v + verbose mode; enable showing debug output + -w [integer] + for stats mode: wait time in seconds betweeen each test or on missing file; default: 5 sec ``` @@ -50,6 +49,10 @@ Each time you touch the testfile it should show "hello". ## Use as systemd service +With running the script as a service can be helpful if you administrate servers and habe developer teams with limited access. Instead of giving sudo permissions you can watch a touchfile to execute something specific as root, i.e. restart Apache httpd. In the real world this file would be touched during an automated deploy process. + +Below is just an example service watching a dummy file in /tmp directory. + In `/etc/systemd/system/` create a service config file **onfilechange-demo.service** ``` @@ -70,6 +73,6 @@ Type=simple WantedBy=multi-user.target ``` - Check if the service exists `systemctl status onfilechange-demo`. If so you can start and stop it with `systemctl [start|stop] onfilechange-demo` +To start the service on reboot you additionally need to enable it: `systemctl enable onfilechange-demo`. \ No newline at end of file