check in checkinator into hswaw/checkinator
repository: https://code.hackerspace.pl/checkinator
revision: 713c7e6c1a8fd6147522c1a5e3067898a1d8bf7a
Change-Id: I1bd2975a46ec0d9a89d6594fb4b9d49832001627
Reviewed-on: https://gerrit.hackerspace.pl/c/hscloud/+/1219
Reviewed-by: q3k <q3k@hackerspace.pl>
diff --git a/hswaw/checkinator/README.rst b/hswaw/checkinator/README.rst
new file mode 100644
index 0000000..a0414d1
--- /dev/null
+++ b/hswaw/checkinator/README.rst
@@ -0,0 +1,32 @@
+`Warsaw Hackerspace`_ presence tracker hosted on https://at.hackersapce.pl. It
+uses dhcpd.leases file to track MAC adressess of devices connected to hs LAN
+network.
+
+.. _Warsaw Hackerspace: https://hackerspace.pl
+
+Setup
+-----
+.. code:: bash
+
+ cp config.yaml.dist config.yaml
+
+ # edit config file using your favourite editor
+ $EDITOR config.yaml
+
+ # create new database file (or copy existing one)
+ sqlite3 at.db < dbsetup.sql
+
+ # create python virtual environment
+ python3 -m venv vevnv
+ ./venv/bin/python3 -m pip install -r requirements
+ ./venv/bin/python3 -m pip install gunicorn
+
+Running
+-------
+.. code:: bash
+
+ ./venv/bin/gunicorn run:app
+
+When running on OpenBSD make sure to pass '--no-sendfile' argument to gunicorn
+command. This will prevent AttributeError on os.sendfile that seems to be
+missing in this marvelous OS-es python3 stdlib.