diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..58691fa --- /dev/null +++ b/readme.md @@ -0,0 +1,20 @@ +# jatwis + +jatwis is a simple application designed to run scripts when a device is +reported as stolen. it works by polling an https or sftp url for a success +code. if the resource is accessible, it runs a script and optionally creates a +lockfile to prevent multiple triggers. jatwis can also be run on multiple +devices at the same time, so you can for example revoke access from an ssh key +server-side once a device is reported stolen. + +## configuration + +jatwis is configured by giving it command-line arguments. for a full list and +explanation of all possible arguments run `man jatwis`, or `jatwisd --help`. + +## set-up + +clone this repository and run `make install` as root to install the jatwisd +binary in your $PATH. edit the command-line arguments in the systemd unit +(located at /etc/systemd/system/jatwis.service). start/enable the systemd unit +by running `systemctl enable --now jatwis` as root. |