summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorvuko <vuko@hackerspace.pl>2020-06-13 12:13:19 +0200
committervuko <vuko@hackerspace.pl>2020-06-13 12:13:19 +0200
commit68508440d10143fe7429a5d6cc6ae31264cfecf2 (patch)
tree0e9c177cb432a91549b636254062aeca2adc8c48 /README.rst
parentf5cde26030a66608628c3581784074753b6ad679 (diff)
parentbc53e2fe6b20e8d6642c369ceec819b7c7221e3a (diff)
downloadcheckinator-68508440d10143fe7429a5d6cc6ae31264cfecf2.tar.gz
checkinator-68508440d10143fe7429a5d6cc6ae31264cfecf2.tar.bz2
checkinator-68508440d10143fe7429a5d6cc6ae31264cfecf2.zip
preparation for parsing and webapp splitHEADmaster
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..28e4f8b
--- /dev/null
+++ b/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 at.cfg.dist at.dist
+
+ # edit config file using your favourite editor
+ $EDITOR at.cfg
+
+ # 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.