Browse Source

K4ever install documentation

Sebastian Lohff 9 years ago
parent
commit
bef462a86d
4 changed files with 85 additions and 55 deletions
  1. 3
    53
      devel/README
  2. 2
    1
      k4ever/docs/index.rst
  3. 80
    0
      k4ever/docs/install.rst
  4. 0
    1
      k4ever/settings.py.template

+ 3
- 53
devel/README View File

@@ -1,55 +1,5 @@
1
-Kassensystem
2
-############
1
+This is not the main documentation for k4ever. It resides in 
2
+k4ever/k4ever/docs or online somewhere at http://k4ever.someserver.de/
3
+so go and take a look there.
3 4
 
4
-Preamble
5
-========
6
-For ages there has been the discussion - Kassensystem! 
7
-
8
-So many attempts have been made, so many things have been discussed
9
-and overengineered... But oh well, here is our attempt!
10
-
11
-
12
-Mighty Kassensystem, finally!
13
-
14
-Dependencies
15
-============
16
- - python-django >= 1.3
17
- - python-django-auth-ldap
18
- - python-django-piston
19
- - easy-thumbnails
20
- 	https://github.com/SmileyChris/easy-thumbnails.git
21
-
22
-
23
-Installation Process
24
-====================
25
-
26
-1. Webserver
27
-
28
-Some sort of Webserver is needed to host the django part. All about deploying
29
-django can be found at https://docs.djangoproject.com/en/dev/howto/deployment/
30
-Mostly this will be apache2 + mod_wsgi.
31
-
32
-k4ever has static files which should be served by the webserver directly, so
33
-be sure to turn off python for the media/ directory.
34
-
35
-For development there is also djangos builtin webserver. You can use it via
36
-./manage.py runserver but THIS SHOULD NEVER BE USED IN A PRODOCTIVE
37
-ENVIRONMENT.
38
-
39
-
40
-
41
-2. The database
42
- - edit settings.py for database
43
- - Add Usergroups: ('Normal User', 'Plugin') ( to be renamed)
44
- - ./manage.py syncdb
45
- - install script for needed data will be written.
46
-
47
-
48
-Documentation
49
-=============
50
-
51
-Yes, there is more documentation than this readme! It is present
52
-at k4ever/docs/, but if you want (and have python-sphinx) installed,
53
-you can compile it to nice html (or pdf, ...) pages. There is a
54
-``Makefile`` present to your assistance.
55 5
 

+ 2
- 1
k4ever/docs/index.rst View File

@@ -10,7 +10,8 @@ Contents:
10 10
 
11 11
 .. toctree::
12 12
    :maxdepth: 2
13
-    
13
+
14
+   install
14 15
    django/api
15 16
    faq
16 17
 

+ 80
- 0
k4ever/docs/install.rst View File

@@ -0,0 +1,80 @@
1
+.. This is the install documentation for a typical k4ever setup.
2
+
3
+Installation
4
+============
5
+This is the installation manual for all the parts of k4ever.
6
+
7
+k4ever Webinterface + API
8
+-------------------------
9
+The k4ever webinterface is a Django application. You will need some sort of
10
+webserver and something that runs python code. 
11
+
12
+
13
+Dependencies
14
+````````````
15
+ - django >= 1.3
16
+ - django-piston
17
+ - easy-thumbnails
18
+ - django-auth-ldap (if you want ldap support)
19
+
20
+All of these are available via pip.
21
+
22
+
23
+Webserver Configuration
24
+```````````````````````
25
+In this example configuration we will use apache2 + mod_wsgi, but there are
26
+many other choices. These are described in Django's docs at `deploying Django
27
+<https://docs.djangoproject.com/en/dev/howto/deployment/>_`.
28
+
29
+k4ever has static files which should be served by the webserver directly, so
30
+be sure this happens for the media/ directory.
31
+
32
+Here is an apache2 example configuration::
33
+
34
+	<VirtualHost *:80>
35
+		ServerName k4ever.example.com
36
+		ServerAdmin k4ever@example.com
37
+
38
+		DocumentRoot "/home/k4ever/k4ever/"
39
+
40
+		Alias /media/ /home/k4ever/k4ever/k4ever/media/
41
+		<Location /media>
42
+			Options +FollowSymlinks
43
+			Options -Indexes
44
+		</Location>
45
+		
46
+		# wsgi
47
+        WSGIScriptAlias / /home/k4ever/k4ever.wsgi
48
+        WSGIDaemonProcess k4ever user=k4ever group=k4ever processes=5 threads=1
49
+        WSGIProcessGroup k4ever
50
+        WSGIPassAuthorization On
51
+	</VirtualHost>
52
+
53
+.. note::
54
+
55
+	You might want k4ever to be only reachable via https as k4ever's webinterface
56
+	and API depend upon password authentication. Not having encrypted connections
57
+	to your webserver will cause password loss.
58
+
59
+Configuration
60
+`````````````
61
+Copy over the settings.py.template to settings.py. You can edit all the
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
64
+are k4ever specific and have some inline documentation.
65
+
66
+The **SECRET_KEY** variable has to be set by you. Just set it to something long
67
+and kind of random. 60 characters should be sufficient.
68
+
69
+If you want to add LDAP-Support to your instance of k4ever, edit the ldap
70
+part of the config and make sure you have django-auth-ldap installed. All
71
+users logging in via LDAP are added to djangos user database on login. They
72
+have an invalid password, so they only can login via ldap. For more
73
+documentation about this subject, look at django-auth-ldap's documentation.
74
+
75
+If you want to see more settings (the parts we think nobody needs to change)
76
+take a look at settings_default.py. DON'T overwrite them in there as it might
77
+cause a *git pull* to fail, just put them in your settings.py and they will
78
+get overridden.
79
+
80
+

+ 0
- 1
k4ever/settings.py.template View File

@@ -46,7 +46,6 @@ SECRET_KEY = ''
46 46
 # LDAP configuration
47 47
 USE_LDAP = False
48 48
 if USE_LDAP:
49
-	
50 49
 	# For more information about the LDAP backend look the docs for
51 50
 	# django-auth-ldap - http://packages.python.org/django-auth-ldap/
52 51
 	AUTH_LDAP_SERVER_URI = 'ldaps://your.server'

Loading…
Cancel
Save