Statistics
| Branch: | Tag: | Revision:

root / okeanos_site / README @ fe9c347a

History | View | Annotate | Download (2.1 kB)

1
~Okeanos intro site application
2
===============================
3

    
4
About
5
-----
6
This is a django application that contains the intro site 
7
pages for ~okeanos project.
8

    
9
Its placed inside synnefo repository for convenience pupropses 
10
to ease the deployment process for the alpha version of the
11
project.
12

    
13

    
14
Static files
15
------------
16
The application provides its own static files (images/css/js) 
17
seperated from the ones included in ui application. For convenience 
18
the url of the static files can be dynamicly change by proper set 
19
of the OKEANOS_STATIC_URL setting variable.
20

    
21

    
22
Settings
23
--------
24
- OKEANOS_STATIC_URL
25
  See `Static files`.
26

    
27
  Defaults to "/okeanos_static/"
28

    
29
- OKEANOS_SITE_URL
30
  The url of the intro site (that displays the 
31
  introductory application video)
32

    
33
  Defaults to "/okeanos"
34

    
35
- OKEANOS_APP_URL
36
  The url of the ~okeanos webapp.
37

    
38
  Defaults to "/"
39

    
40
- OKEANOS_VIDEO_URL
41
  Vimeo flash url.
42
  Make the following steps to retrieve the appropriate url
43

    
44
  - open vimeo video page
45
  - click on the embed button 
46
    (on the right side of the video container)
47
  - click on "old embed code" to view the flash embedable html code
48
  - extract the url from <embed src="<video url>"
49

    
50

    
51
Views
52
-----
53
The application contains 2 views. 
54

    
55
The okeanos_site.views.intro that displays the ~okeanos logo
56
and redirects to `OKEANOS_SITE_URL`.
57

    
58
The okeanos_site.views.index that displays the introductory 
59
video/info and depending on if the user already has the web app
60
cookie displays a link that forwards user to the `OKEANOS_APP_URL`.
61

    
62

    
63
Templates
64
---------
65
The content of the info blocks (who/why/what) are placed in
66
templates/okeanos/pages directory.
67

    
68

    
69
Urls
70
----
71
The application contains a convenience `urls.py` file which
72
extends the synnefo urlpatterns with two extra urls and modifies.
73

    
74

    
75
Deploying synnefo with ~okeanos intro pages
76
-------------------------------------------
77

    
78
A sample configuration file with documented settings 
79
modifications exists in okeanos_site/90-okeanos.conf.sample .
80

    
81
The sample configuration file contains all settings needed
82
for the smooth deployment of ~okeanos aplha release with no extra
83
modifications on the synnefo application settings.
84