initial commit

2 files changed, 41 insertions, 0 deletions

diff --git a/license b/license
new file mode 100644
index 0000000..2c47bb6
--- /dev/null
+++ b/license
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 lonkaars
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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.