seba
/
k4ever
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Install documentation for k4ever and barcode-plugin

This commit is contained in:
Sebastian Lohff 2012-01-29 04:39:06 +01:00
parent ff7ef54e7e
commit d6bcb172fb
1 changed files with 44 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
k4ever/docs/install.rst
View File

@ -24,7 +24,7 @@ Webserver Configuration
``````````````````````` ```````````````````````
In this example configuration we will use apache2 + mod_wsgi, but there are In this example configuration we will use apache2 + mod_wsgi, but there are
many other choices. These are described in Django's docs at `deploying Django many other choices. These are described in Django's docs at `deploying Django
<https://docs.djangoproject.com/en/dev/howto/deployment/>_`. <https://docs.djangoproject.com/en/dev/howto/deployment/>`_.
k4ever has static files which should be served by the webserver directly, so k4ever has static files which should be served by the webserver directly, so
be sure this happens for the media/ directory. be sure this happens for the media/ directory.
@ -60,7 +60,7 @@ Configuration
````````````` `````````````
Copy over the settings.py.template to settings.py. You can edit all the Copy over the settings.py.template to settings.py. You can edit all the
settings fitting to your needs. Most of them are django switches, documented settings fitting to your needs. Most of them are django switches, documented
`here <https://docs.djangoproject.com/en/dev/topics/settings/>_`. Some of them `here <https://docs.djangoproject.com/en/dev/topics/settings/>`_. Some of them
are k4ever specific and have some inline documentation. are k4ever specific and have some inline documentation.
The **SECRET_KEY** variable has to be set by you. Just set it to something long The **SECRET_KEY** variable has to be set by you. Just set it to something long
@ -78,3 +78,45 @@ cause a *git pull* to fail, just put them in your settings.py and they will
get overridden. get overridden.
Barcode-Client
--------------
The Barcode-Client is an interface to k4ever which can run on a dedicated
computer/laptop.
Dependencies
````````````
- python
- simplejson
- a terminal
Configuration
`````````````
You'll need a user/password combination in k4ever, so go to k4ever's admin
page and add a new user which is member of the *Plugin* group. Additionally
you need an entry for the Barcode-Reader to appear on the settings page.
All this can be accomplished by calling the *install.py* with the path
to your k4ever django installation::
python install.py ../k4ever/
At this point the Barcode-Client has no configuration file. All you have to do
is to set three environment variables according to your setup::
export BARCODE_PLUGIN_USER=yourpluginuser
export BARCODE_PLUGIN_PASS=yourpluginpass
export BARCODE_PLUGIN_URL=https://path-to.your/api2/
Afterwards you can start the Barcode-Client with *python freitagskasse.py*.
If you have a Barcode-Scanner: Normally barcodescanners just act as a normal
keyboard. Just let it type the barcodes into the Barcode-Client and everything
should work.
If you have a RFID-Reader: Most RFID-Cards have an ID which can be used to
authenticate against k4ever. A user needs to take this ID and put it in the
authblob section. For an RFID_Reader to work with k4ever you can use the
*rfid_keypresser.py*, which reads all input from the reader and translates
them to X keypresses.