Revision 19e371a0 README.txt

b/README.txt
1
===========
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

  
2 29
1. Tool requirements
3 30

  
4 31
* python-django
......
18 45
 *  OpenId support depends on python-openid
19 46
 *  OAuth support depends on python-oauth2 
20 47

  
48
2. Installation
49

  
50
* Install all required packages/libs.
51
* settings.py changes:
52
 * Set database backend, static url, template dirs
53
 * Social Auth requires setting up the appropriate TEMPLATE_CONTEXT_PROCESSORS and AUTHENTICATION_BACKENDS
54
 * To use Shibboleth set a valid SHIB_AUTH_ENTITLEMENT
55
 * Set email settings SERVER_EMAIL, EMAIL_SUBJECT_PREFIX
56
 * To notify certain people uppon user registration set their email accounts at: NOTIFY_ADMIN_MAILS
57
 * Set TINYMCE_JS_URL
58
 * If you wish to use a cache backend (recomended) set the CACHE_BACKEND
59
 * NRO variables are used in templates:
60
  * 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
61
 * If you wish to use LDAP for the overview set the LDAP_AUTH_SETTINGS
62
 * To use the django social auth plugin set the api keys/secret of the active social media auth providers
63
  * Django social auth is higly customizable: http://django-social-auth.readthedocs.org/en/latest/index.html
64

  
65
* Run:
66
 * ./manage.py syncdb (create a super-user)
67
 * ./manage.py migrate
68
* To start with, you must create a Realm with a related contact.
69
* It is suggested to do this via the admin interface.
70

  
71
Invite your users to use it.
21 72

  
22 73

  

Also available in: Unified diff