aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: 58691fa767edda809c2f2e02a0e9192de165d87b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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.