Statistics
| Branch: | Tag: | Revision:

root / okeanos_site / README @ 5039a44f

History | View | Annotate | Download (2.4 kB)

1 0768522a Kostas Papadimitriou
~Okeanos intro site application
2 0768522a Kostas Papadimitriou
===============================
3 0768522a Kostas Papadimitriou
4 0768522a Kostas Papadimitriou
About
5 0768522a Kostas Papadimitriou
-----
6 0768522a Kostas Papadimitriou
This is a django application that contains the intro site 
7 0768522a Kostas Papadimitriou
pages for ~okeanos project.
8 0768522a Kostas Papadimitriou
9 0768522a Kostas Papadimitriou
Its placed inside synnefo repository for convenience pupropses 
10 0768522a Kostas Papadimitriou
to ease the deployment process for the alpha version of the
11 0768522a Kostas Papadimitriou
project.
12 0768522a Kostas Papadimitriou
13 0768522a Kostas Papadimitriou
14 0768522a Kostas Papadimitriou
Static files
15 0768522a Kostas Papadimitriou
------------
16 0768522a Kostas Papadimitriou
The application provides its own static files (images/css/js) 
17 0768522a Kostas Papadimitriou
seperated from the ones included in ui application. For convenience 
18 0768522a Kostas Papadimitriou
the url of the static files can be dynamicly change by proper set 
19 0768522a Kostas Papadimitriou
of the OKEANOS_STATIC_URL setting variable.
20 0768522a Kostas Papadimitriou
21 0768522a Kostas Papadimitriou
22 0768522a Kostas Papadimitriou
Settings
23 0768522a Kostas Papadimitriou
--------
24 0768522a Kostas Papadimitriou
- OKEANOS_STATIC_URL
25 0768522a Kostas Papadimitriou
  See `Static files`.
26 0768522a Kostas Papadimitriou
27 0768522a Kostas Papadimitriou
  Defaults to "/okeanos_static/"
28 0768522a Kostas Papadimitriou
29 0768522a Kostas Papadimitriou
- OKEANOS_SITE_URL
30 0768522a Kostas Papadimitriou
  The url of the intro site (that displays the 
31 0768522a Kostas Papadimitriou
  introductory application video)
32 0768522a Kostas Papadimitriou
33 0768522a Kostas Papadimitriou
  Defaults to "/okeanos"
34 0768522a Kostas Papadimitriou
35 0768522a Kostas Papadimitriou
- OKEANOS_APP_URL
36 0768522a Kostas Papadimitriou
  The url of the ~okeanos webapp.
37 0768522a Kostas Papadimitriou
38 0768522a Kostas Papadimitriou
  Defaults to "/"
39 0768522a Kostas Papadimitriou
40 0768522a Kostas Papadimitriou
- OKEANOS_VIDEO_URL
41 4beadc2f Kostas Papadimitriou
  
42 4beadc2f Kostas Papadimitriou
  Since the transition to our custom html5 player the OKEANOS_VIDEO_URL should
43 4beadc2f Kostas Papadimitriou
  be set to a dict containing the several videos added inside <video> html tag
44 8b5381f3 Kostas Papadimitriou
45 4beadc2f Kostas Papadimitriou
  Dict key should be the video format and its value another dict containing the
46 4beadc2f Kostas Papadimitriou
  <source> tag attributes. At least `src` attribute should be set for video to
47 4beadc2f Kostas Papadimitriou
  work.
48 0768522a Kostas Papadimitriou
49 4beadc2f Kostas Papadimitriou
  A sample dict provided in `90-okeanos.conf.sample` file.
50 4beadc2f Kostas Papadimitriou
51 4beadc2f Kostas Papadimitriou
  IE fallbacks to a flash video player called `flowplayer`. For video to work
52 4beadc2f Kostas Papadimitriou
  on IE OKEANOS_VIDEO_URL setting should contain mp4 video source. The url of
53 4beadc2f Kostas Papadimitriou
  mp4 should be an ABSOLUTE URL for flash player to work.
54 0768522a Kostas Papadimitriou
55 0768522a Kostas Papadimitriou
Views
56 0768522a Kostas Papadimitriou
-----
57 0768522a Kostas Papadimitriou
The application contains 2 views. 
58 0768522a Kostas Papadimitriou
59 8b5381f3 Kostas Papadimitriou
The okeanos_site.views.intro that displays the ~okeanos logo
60 0768522a Kostas Papadimitriou
and redirects to `OKEANOS_SITE_URL`.
61 0768522a Kostas Papadimitriou
62 0768522a Kostas Papadimitriou
The okeanos_site.views.index that displays the introductory 
63 0768522a Kostas Papadimitriou
video/info and depending on if the user already has the web app
64 0768522a Kostas Papadimitriou
cookie displays a link that forwards user to the `OKEANOS_APP_URL`.
65 0768522a Kostas Papadimitriou
66 0768522a Kostas Papadimitriou
67 0768522a Kostas Papadimitriou
Templates
68 0768522a Kostas Papadimitriou
---------
69 0768522a Kostas Papadimitriou
The content of the info blocks (who/why/what) are placed in
70 0768522a Kostas Papadimitriou
templates/okeanos/pages directory.
71 0768522a Kostas Papadimitriou
72 0768522a Kostas Papadimitriou
73 0768522a Kostas Papadimitriou
Urls
74 0768522a Kostas Papadimitriou
----
75 0768522a Kostas Papadimitriou
The application contains a convenience `urls.py` file which
76 8b5381f3 Kostas Papadimitriou
extends the synnefo urlpatterns with two extra urls and modifies.
77 8b5381f3 Kostas Papadimitriou
78 8b5381f3 Kostas Papadimitriou
79 8b5381f3 Kostas Papadimitriou
Deploying synnefo with ~okeanos intro pages
80 8b5381f3 Kostas Papadimitriou
-------------------------------------------
81 8b5381f3 Kostas Papadimitriou
82 8b5381f3 Kostas Papadimitriou
A sample configuration file with documented settings 
83 8b5381f3 Kostas Papadimitriou
modifications exists in okeanos_site/90-okeanos.conf.sample .
84 8b5381f3 Kostas Papadimitriou
85 8b5381f3 Kostas Papadimitriou
The sample configuration file contains all settings needed
86 8b5381f3 Kostas Papadimitriou
for the smooth deployment of ~okeanos aplha release with no extra
87 8b5381f3 Kostas Papadimitriou
modifications on the synnefo application settings.