root / okeanos_site / README @ 404ccab2
History | View | Annotate | Download (2.6 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 |
|
42 |
Since the transition to our custom html5 player the OKEANOS_VIDEO_URL should |
43 |
be set to a dict containing the several videos added inside <video> html tag |
44 |
|
45 |
Dict key should be the video format and its value another dict containing the |
46 |
<source> tag attributes. At least `src` attribute should be set for video to |
47 |
work. |
48 |
|
49 |
A sample dict provided in `90-okeanos.conf.sample` file. |
50 |
|
51 |
IE fallbacks to a flash video player called `flowplayer`. For video to work |
52 |
on IE OKEANOS_VIDEO_URL setting should contain mp4 video source. The url of |
53 |
mp4 should be an ABSOLUTE URL for flash player to work. |
54 |
|
55 |
- OKEANOS_POSTER_URL |
56 |
|
57 |
Should contain a url to an image we want to display on top of video |
58 |
while video is loading. |
59 |
|
60 |
- OKEANOS_FLOWPLAYER_URL |
61 |
|
62 |
Should contain url to flowplayer plugin swf |
63 |
|
64 |
Views |
65 |
----- |
66 |
The application contains 2 views. |
67 |
|
68 |
The okeanos_site.views.intro that displays the ~okeanos logo |
69 |
and redirects to `OKEANOS_SITE_URL`. |
70 |
|
71 |
The okeanos_site.views.index that displays the introductory |
72 |
video/info and depending on if the user already has the web app |
73 |
cookie displays a link that forwards user to the `OKEANOS_APP_URL`. |
74 |
|
75 |
|
76 |
Templates |
77 |
--------- |
78 |
The content of the info blocks (who/why/what) are placed in |
79 |
templates/okeanos/pages directory. |
80 |
|
81 |
|
82 |
Urls |
83 |
---- |
84 |
The application contains a convenience `urls.py` file which |
85 |
extends the synnefo urlpatterns with two extra urls and modifies. |
86 |
|
87 |
|
88 |
Deploying synnefo with ~okeanos intro pages |
89 |
------------------------------------------- |
90 |
|
91 |
A sample configuration file with documented settings |
92 |
modifications exists in okeanos_site/90-okeanos.conf.sample . |
93 |
|
94 |
The sample configuration file contains all settings needed |
95 |
for the smooth deployment of ~okeanos aplha release with no extra |
96 |
modifications on the synnefo application settings. |
97 |
|