hscloud/hswaw/checkinator/README.rst
vuko 2afcbddf6a hswaw/checkinator: update README
Change-Id: Ib3c92c1b707d9effe566e219cc5d65d850a91ab3
Reviewed-on: https://gerrit.hackerspace.pl/c/hscloud/+/1241
Reviewed-by: q3k <q3k@hackerspace.pl>
2022-03-07 11:52:33 +00:00

36 lines
916 B
ReStructuredText

`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.
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
-----
.. code:: bash
cp config.yaml.dist config.yaml
cp web-config.yaml.dist web-config.yaml
# 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
# build
nix-build ../../default.nix -A hswaw.checkinator
Running
-------
.. code:: bash
# run tracker
./result/bin/checkinator-tracker config.yaml
# run web interface
# TODO: fix running debug entry point from nix build
./result/bin/checkinator-web-debug