root / README.txt @ 022d93af
History | View | Annotate | Download (4.1 kB)
1 |
Copyright © 2011-2013 Greek Research and Technology Network (GRNET S.A.) |
---|---|
2 |
|
3 |
Developed by Leonidas Poulopoulos (leopoul-at-noc-dot-grnet-dot-gr) and |
4 |
Zenon Mousmoulas (zmousm-at-noc-dot-grnet-dot-gr), GRNET NOC |
5 |
|
6 |
Permission to use, copy, modify, and/or distribute this software for any |
7 |
purpose with or without fee is hereby granted, provided that the above |
8 |
copyright notice and this permission notice appear in all copies. |
9 |
|
10 |
THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD |
11 |
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND |
12 |
FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR |
13 |
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, |
14 |
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS |
15 |
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS |
16 |
SOFTWARE. |
17 |
|
18 |
================= |
19 |
DjNRO |
20 |
================= |
21 |
|
22 |
DjNRO is more than keeping eduroam.org updated with data. In essence it is a distributed management application. |
23 |
It is distributed in the sense that information about each institution locations and services is kept up-to-date by each local eduroam administrator. |
24 |
Keeping in pace with eduroam's federated nature, the implementation uses federated authentication/authorisation mechanisms, namely Shibboleth plus social media itegration. |
25 |
The local institution eduroam administrators can become DjNRO admins. Local eduroam administrators register to the application via Shibboleth. |
26 |
Once the accounts are acitvated, local eduroam admins can manage their eduroam locations, contact points and institution information. |
27 |
|
28 |
For detailed installation/configuration steps and options, you can read DjNRO's documentation |
29 |
|
30 |
1. Tool requirements |
31 |
|
32 |
DjNRO heavily depends on the following: |
33 |
|
34 |
* Python (<3 & >=2.6) |
35 |
* Django (>=1.2) - python-django |
36 |
* memcached |
37 |
* python-django-extensions |
38 |
* python-mysqldb (If you wish to use MySQL as the DB backend) |
39 |
* mysql-client-5.1 |
40 |
* python-ipaddr |
41 |
* python-django-south (For database migrations) |
42 |
* python-django-tinymce (Flatpages editing made easier) |
43 |
* python-memcache (Yeap! You need that for Google maps locations caching) |
44 |
* python-django-registration (User activation made easy) |
45 |
* apache2 (We suggest apache with mod_rewrite enabled - use your preferred server) |
46 |
* libapache2-mod-wsgi |
47 |
* apache2-shibboleth : The server should be setup as a Shibboleth SP |
48 |
* A mail server - Tested with exim |
49 |
* python-django-social-auth |
50 |
* OpenId support depends on python-openid |
51 |
* OAuth support depends on python-oauth2 |
52 |
|
53 |
2. Installation |
54 |
|
55 |
* Install all required packages/libs. |
56 |
* settings.py changes: |
57 |
* Set database backend, static url, template dirs |
58 |
* Social Auth requires setting up the appropriate TEMPLATE_CONTEXT_PROCESSORS and AUTHENTICATION_BACKENDS |
59 |
* To use Shibboleth set a valid SHIB_AUTH_ENTITLEMENT |
60 |
* Set email settings SERVER_EMAIL, EMAIL_SUBJECT_PREFIX |
61 |
* To notify certain people uppon user registration set their email accounts at: NOTIFY_ADMIN_MAILS |
62 |
* Set TINYMCE_JS_URL |
63 |
* If you wish to use a cache backend (recomended) set the CACHE_BACKEND |
64 |
* NRO variables are used in templates: |
65 |
* NRO_COUNTRY_NAME, NRO_COUNTRY_CODE, NRO_DOMAIN_MAIN_URL, NRO_DEV_BY_DICT, NRO_DEV_SOCIAL_MEDIA_CONTACT, MAP_CENTER, NRO_DOMAIN_HELPDESK_DICT |
66 |
* If you wish to use LDAP for the overview set the LDAP_AUTH_SETTINGS |
67 |
* To use the django social auth plugin set the api keys/secret of the active social media auth providers |
68 |
* Django social auth is higly customizable: http://django-social-auth.readthedocs.org/en/latest/index.html |
69 |
|
70 |
* Run: |
71 |
* ./manage.py syncdb (create a super-user) |
72 |
* ./manage.py migrate |
73 |
* To start with, you must create a Realm with a related contact. |
74 |
* It is suggested to do this via the admin interface. |
75 |
|
76 |
The suggested web server setup is apache with mod_wsgi and mod_shib. |
77 |
Static folder should be served as /static Alias (Apache configuration). |
78 |
|
79 |
3. Logos/Branding |
80 |
|
81 |
Inside the static/img/eduroam_branding folder you will find the xcf (Gimp) logo files logo_holder, logo small. Edit with Gimp according to your needs and save as logo_holder.png and logo_small.png inside the static/img folder |
82 |
|
83 |
4. Done! |
84 |
|
85 |
Invite your users to use it. |
86 |
|
87 |
|