Browse Source

Docs: Install documentation for k4ever and barcode-plugin

Sebastian Lohff 9 years ago
parent
commit
d6bcb172fb
1 changed files with 44 additions and 2 deletions
  1. 44
    2
      k4ever/docs/install.rst

+ 44
- 2
k4ever/docs/install.rst View File

@@ -24,7 +24,7 @@ Webserver Configuration
24 24
 ```````````````````````
25 25
 In this example configuration we will use apache2 + mod_wsgi, but there are
26 26
 many other choices. These are described in Django's docs at `deploying Django
27
-<https://docs.djangoproject.com/en/dev/howto/deployment/>_`.
27
+<https://docs.djangoproject.com/en/dev/howto/deployment/>`_.
28 28
 
29 29
 k4ever has static files which should be served by the webserver directly, so
30 30
 be sure this happens for the media/ directory.
@@ -60,7 +60,7 @@ Configuration
60 60
 `````````````
61 61
 Copy over the settings.py.template to settings.py. You can edit all the
62 62
 settings fitting to your needs. Most of them are django switches, documented
63
-`here <https://docs.djangoproject.com/en/dev/topics/settings/>_`. Some of them
63
+`here <https://docs.djangoproject.com/en/dev/topics/settings/>`_. Some of them
64 64
 are k4ever specific and have some inline documentation.
65 65
 
66 66
 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
78 78
 get overridden.
79 79
 
80 80
 
81
+Barcode-Client
82
+--------------
83
+The Barcode-Client is an interface to k4ever which can run on a dedicated
84
+computer/laptop.
85
+
86
+
87
+Dependencies
88
+````````````
89
+ - python
90
+ - simplejson
91
+ - a terminal
92
+
93
+
94
+Configuration
95
+`````````````
96
+You'll need a user/password combination in k4ever, so go to k4ever's admin
97
+page and add a new user which is member of the *Plugin* group. Additionally
98
+you need an entry for the Barcode-Reader to appear on the settings page.
99
+All this can be accomplished by calling the *install.py* with the path
100
+to your k4ever django installation::
101
+
102
+	python install.py ../k4ever/
103
+
104
+At this point the Barcode-Client has no configuration file. All you have to do
105
+is to set three environment variables according to your setup::
106
+
107
+	export BARCODE_PLUGIN_USER=yourpluginuser
108
+	export BARCODE_PLUGIN_PASS=yourpluginpass
109
+	export BARCODE_PLUGIN_URL=https://path-to.your/api2/
110
+
111
+Afterwards you can start the Barcode-Client with *python freitagskasse.py*.
112
+
113
+If you have a Barcode-Scanner: Normally barcodescanners just act as a normal
114
+keyboard. Just let it type the barcodes into the Barcode-Client and everything
115
+should work.
116
+
117
+If you have a RFID-Reader: Most RFID-Cards have an ID which can be used to 
118
+authenticate against k4ever. A user needs to take this ID and put it in the
119
+authblob section. For an RFID_Reader to work with k4ever you can use the
120
+*rfid_keypresser.py*, which reads all input from the reader and translates
121
+them to X keypresses.
122
+

Loading…
Cancel
Save