Statistics
| Branch: | Tag: | Revision:

root / snf-pithos-webclient / README @ 02f1204b

History | View | Annotate | Download (2.7 kB)

1
snf-pithos-webclient
2
********************
3

    
4
This is the python package of the pithos frontend web application. It consists
5
of a django application module which includes a prebuilt version of the pithos
6
gwt project contained in `../src` directory.
7

    
8
The gwt build files are not included in the repository. Ant hooks has been
9
added in setup.py so that each time you run ``python setup.py {develop,
10
install, sdist}`` ant build gets executed automatically for you.  Additionally
11
after each successfull build, compiled js and other asset files are copied in
12
the appropriate locations so that they will get included in the created python
13
package.
14

    
15

    
16
Installation
17
============
18

    
19
1. Install the ``snf-pithos-webclient`` python package:
20

    
21
    pip install snf-pithos-webclient -f http://docs.dev.grnet.gr/pypi/
22

    
23
2. Add ``pithos_webclient`` in your django project INSTALLED_APPS setting.
24

    
25
3. Configure your web server to serve package static files placed in
26
   pithos_web_client/static/pithos_web_client under the
27
   ``/static/pithos_web_client`` url (``/static/`` is the default django
28
   MEDIA_URL).
29

    
30

    
31
Available settings
32
==================
33

    
34
The pithos webclient use the following settings 
35

    
36

    
37
PITHOS_UI_LOGIN_URL
38
-------------------
39
Web client checks for existing ``PITHOS_UI_AUTH_COOKIE_NAME`` cookie on the
40
browser and if found, uses the stored token to make requests to the pithos api
41
service. If cookie is not found or if api response with 401 error, the
42
application will redirect to the ``PITHOS_UI_LOGIN_URL``. ``next`` parameter
43
gets automatically appended in the url by the webclient.
44

    
45
**default value:** ``https://accounts.okeanos.grnet.gr/im/login?next=``
46

    
47

    
48
PITHOS_UI_FEEDBACK_URL
49
----------------------
50
Should be set to match your astakos deployment feedback endpoint. This is used
51
in error messages, if user want to submit the error as feedback to the service
52
administrators.
53

    
54
**default value:** ``https://accounts.okeanos.grnet.gr/im/feedback``
55

    
56

    
57
PITHOS_UI_AUTH_COOKIE_NAME
58
--------------------------
59
The cookie name the webclient will check for user authenticity. This
60
should match the ``ASTAKOS_COOKIE_NAME`` setting of your astakos deployment.
61

    
62
**default value:** ``_pithos2_a``
63

    
64

    
65
PITHOS_CLOUDBAR_ACTIVE_SERVICE
66
------------------------------
67
This is passed as a setting to the cloudbar js script to set focus to the
68
appropriate service menu. This should match the `id` key of
69
``ASTAKOS_CLOUD_SERVICES`` entry which refers to pithos application.
70

    
71
**default value:** ``pithos``
72

    
73

    
74
CLOUDBAR_SETTINGS
75
-----------------
76
Webclient also makes use of the ``cloudbar`` context processor located in
77
``snf-common`` package which requires ``CLOUDBAR_ACTIVE``,
78
``CLOUDBAR_LOCATION``, ``CLOUDBAR_COOKIE_NAME``, ``CLOUDBAR_SERVICES_URL``,
79
``CLOUDBAR_MENU_URL`` settings to be set.
80