hswaw/checkinator: update README
Change-Id: Ib3c92c1b707d9effe566e219cc5d65d850a91ab3
Reviewed-on: https://gerrit.hackerspace.pl/c/hscloud/+/1241
Reviewed-by: q3k <q3k@hackerspace.pl>
diff --git a/hswaw/checkinator/README.rst b/hswaw/checkinator/README.rst
index a0414d1..e76b600 100644
--- a/hswaw/checkinator/README.rst
+++ b/hswaw/checkinator/README.rst
@@ -2,6 +2,9 @@
uses dhcpd.leases file to track MAC adressess of devices connected to hs LAN
network.
+This is running on `customs` machine. Go to
+``hswaw/machines/customs.hackerspace.pl`` to see how it is deployed.
+
.. _Warsaw Hackerspace: https://hackerspace.pl
Setup
@@ -9,24 +12,25 @@
.. code:: bash
cp config.yaml.dist config.yaml
+ cp web-config.yaml.dist web-config.yaml
- # edit config file using your favourite editor
+ # edit config files using your favourite editor
$EDITOR config.yaml
+ $EDITOR web-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
+ # build
+ nix-build ../../default.nix -A hswaw.checkinator
Running
-------
.. code:: bash
- ./venv/bin/gunicorn run:app
+ # run tracker
+ ./result/bin/checkinator-tracker config.yaml
-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.
+ # run web interface
+ # TODO: fix running debug entry point from nix build
+ ./result/bin/checkinator-web-debug