Statistics
| Branch: | Tag: | Revision:

root / okeanos_site / README @ d18b2450

History | View | Annotate | Download (2.1 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 0768522a Kostas Papadimitriou
  Vimeo flash url.
42 8b5381f3 Kostas Papadimitriou
  Make the following steps to retrieve the appropriate url
43 8b5381f3 Kostas Papadimitriou
44 8b5381f3 Kostas Papadimitriou
  - open vimeo video page
45 8b5381f3 Kostas Papadimitriou
  - click on the embed button 
46 8b5381f3 Kostas Papadimitriou
    (on the right side of the video container)
47 8b5381f3 Kostas Papadimitriou
  - click on "old embed code" to view the flash embedable html code
48 8b5381f3 Kostas Papadimitriou
  - extract the url from <embed src="<video url>"
49 0768522a Kostas Papadimitriou
50 0768522a Kostas Papadimitriou
51 0768522a Kostas Papadimitriou
Views
52 0768522a Kostas Papadimitriou
-----
53 0768522a Kostas Papadimitriou
The application contains 2 views. 
54 0768522a Kostas Papadimitriou
55 8b5381f3 Kostas Papadimitriou
The okeanos_site.views.intro that displays the ~okeanos logo
56 0768522a Kostas Papadimitriou
and redirects to `OKEANOS_SITE_URL`.
57 0768522a Kostas Papadimitriou
58 0768522a Kostas Papadimitriou
The okeanos_site.views.index that displays the introductory 
59 0768522a Kostas Papadimitriou
video/info and depending on if the user already has the web app
60 0768522a Kostas Papadimitriou
cookie displays a link that forwards user to the `OKEANOS_APP_URL`.
61 0768522a Kostas Papadimitriou
62 0768522a Kostas Papadimitriou
63 0768522a Kostas Papadimitriou
Templates
64 0768522a Kostas Papadimitriou
---------
65 0768522a Kostas Papadimitriou
The content of the info blocks (who/why/what) are placed in
66 0768522a Kostas Papadimitriou
templates/okeanos/pages directory.
67 0768522a Kostas Papadimitriou
68 0768522a Kostas Papadimitriou
69 0768522a Kostas Papadimitriou
Urls
70 0768522a Kostas Papadimitriou
----
71 0768522a Kostas Papadimitriou
The application contains a convenience `urls.py` file which
72 8b5381f3 Kostas Papadimitriou
extends the synnefo urlpatterns with two extra urls and modifies.
73 8b5381f3 Kostas Papadimitriou
74 8b5381f3 Kostas Papadimitriou
75 8b5381f3 Kostas Papadimitriou
Deploying synnefo with ~okeanos intro pages
76 8b5381f3 Kostas Papadimitriou
-------------------------------------------
77 8b5381f3 Kostas Papadimitriou
78 8b5381f3 Kostas Papadimitriou
A sample configuration file with documented settings 
79 8b5381f3 Kostas Papadimitriou
modifications exists in okeanos_site/90-okeanos.conf.sample .
80 8b5381f3 Kostas Papadimitriou
81 8b5381f3 Kostas Papadimitriou
The sample configuration file contains all settings needed
82 8b5381f3 Kostas Papadimitriou
for the smooth deployment of ~okeanos aplha release with no extra
83 8b5381f3 Kostas Papadimitriou
modifications on the synnefo application settings.