Change resource representation
[astakos] / snf-astakos-app / README
index c67fb4c..3f5e21e 100644 (file)
@@ -40,16 +40,14 @@ Settings
 
 Configure in ``settings.py`` or a ``.conf`` file in ``/etc/synnefo`` if using snf-webproject.
 
-==============================      =============================================================================   ===========================================================================================
+=================================== =============================================================================   ===========================================================================================
 Name                                Default value                                                                   Description
-==============================      =============================================================================   ===========================================================================================
+=================================== =============================================================================   ===========================================================================================
 ASTAKOS_AUTH_TOKEN_DURATION         one month                                                                       Expiration time of newly created auth tokens
 ASTAKOS_DEFAULT_USER_LEVEL          4                                                                               Default (not-invited) user level
 ASTAKOS_INVITATIONS_PER_LEVEL       {0:100, 1:2, 2:0, 3:0, 4:0}                                                     Number of user invitations per user level
-ASTAKOS_DEFAULT_FROM_EMAIL          GRNET Cloud <no-reply\@grnet.gr>                                                ``from`` parameter passed in ``django.core.mail.send_mail``
 ASTAKOS_DEFAULT_CONTACT_EMAIL       support\@cloud.grnet.gr                                                         Contact email
-ASTAKOS_DEFAULT_ADMIN_EMAIL         support\@cloud.grnet.gr                                                         Administrator email to receive user creation notifications (if None disables notifications)
-ASTAKOS_IM_MODULES                  ['local', 'shibboleth']                                              Signup modules
+ASTAKOS_IM_MODULES                  ['local', 'shibboleth']                                                         Signup modules
 ASTAKOS_FORCE_PROFILE_UPDATE        True                                                                            Force user profile verification
 ASTAKOS_INVITATIONS_ENABLED         True                                                                            Enable invitations
 ASTAKOS_COOKIE_NAME                 _pithos2_a                                                                      ``Key`` parameter passed in ``django.http.HttpResponse.set_cookie``
@@ -59,9 +57,6 @@ ASTAKOS_IM_STATIC_URL               /static/im/
 ASTAKOS_MODERATION_ENABLED          True                                                                            If False and invitations are not enabled newly created user will be automatically accepted
 ASTAKOS_BASEURL                     \http://pithos.dev.grnet.gr                                                     Astakos baseurl
 ASTAKOS_SITENAME                    GRNET Cloud                                                                     Service name that appears in emails
-ASTAKOS_CLOUD_SERVICES              ({'icon': 'home-icon.png', 'id': 'cloud', 'name': 'grnet cloud', 'url': '/'},   Cloud services appear in the horizontal bar
-                                    {'id': 'okeanos', 'name': 'cyclades', 'url': '/okeanos.html'},                  
-                                    {'id': 'pithos', 'name': 'pithos+', 'url': '/ui/'})                             
 ASTAKOS_RECAPTCHA_ENABLED           True                                                                            Enable recaptcha
 ASTAKOS_RECAPTCHA_PUBLIC_KEY                                                                                        Recaptcha public key obtained after registration here: http://recaptcha.net
 ASTAKOS_RECAPTCHA_PRIVATE_KEY                                                                                       Recaptcha private key obtained after registration here: http://recaptcha.net
@@ -76,9 +71,23 @@ ASTAKOS_RE_USER_EMAIL_PATTERNS      []
 
 ASTAKOS_LOGIN_MESSAGES              {}                                                                              Notification messages to display on login page header
                                                                                                                     e.g. {'warning': 'Warning message (can contain html)'}
-ASTAKOS_PROFILE_EXTRA_LINKS         {}                                                                               messages to display as extra actions in account forms
+ASTAKOS_PROFILE_EXTRA_LINKS         {}                                                                              Messages to display as extra actions in account forms
                                                                                                                     e.g. {'https://cms.okeanos.grnet.gr/': 'Back to ~okeanos'}
-==============================      =============================================================================   ===========================================================================================
+ASTAKOS_RATELIMIT_RETRIES_ALLOWED   3                                                                               Number of unsuccessful login requests per minute allowed for a specific account.
+                                                                                                                    When this number exceeds and ASTAKOS_RECAPTCHA_ENABLED is set the user has to solve a
+                                                                                                                    captcha challenge.
+ASTAKOS_EMAILCHANGE_ENABLED         False                                                                           Enable email change mechanism
+ASTAKOS_EMAILCHANGE_ACTIVATION_DAYS 10                                                                              Number of days that email change requests remain active
+ASTAKOS_LOGGING_LEVEL               INFO                                                                            Message logging severity
+ASTAKOS_QUOTA_HOLDER_URL            ''                                                                              The quota holder URI
+                                                                                                                    e.g. ``http://localhost:8080/api/quotaholder/v``
+ASTAKOS_SERVICES                    {'cyclades': {'url':'https://node1.example.com/ui/', 'quota': {'vm': 2}},       Cloud service default url and quota      
+                                    'pithos+':  {'url':'https://node2.example.com/ui/', 'quota': {                  
+                                    'diskspace': 50 * 1024 * 1024 * 1024}}})                                        
+ASTAKOS_AQUARIUM_URL                ''                                                                              The billing (aquarium) URI
+                                                                                                                    e.g. ``http://localhost:8888/user``
+ASTAKOS_PAGINATE_BY                 10                                                                              Number of object to be displayed per page
+=================================== =============================================================================   ===========================================================================================
 
 Administrator functions
 -----------------------
@@ -103,11 +112,4 @@ showuser         Show user info
 
 To update user credibility from the billing system (Aquarium), enable the queue, install snf-pithos-tools and use ``pithos-dispatcher``::
 
-    pithos-dispatcher --exchange=aquarium --callback=astakos.im.queue.listener.on_creditevent
-
-Load groups:
-------------
-
-To set the initial user groups load the followind fixture:
-
-    snf-manage loaddata groups
+    pithos-dispatcher --exchange=aquarium --callback=astakos.im.endpoints.aquarium.consumer.on_creditevent