X-Git-Url: https://code.grnet.gr/git/astakos/blobdiff_plain/809b6d1168316632ad0b3c2ab64cd4737631e6f7..661c4479404d5ca30a745a185ecb52a0a98bc41f:/snf-astakos-app/README diff --git a/snf-astakos-app/README b/snf-astakos-app/README index a529f10..3f5e21e 100644 --- a/snf-astakos-app/README +++ b/snf-astakos-app/README @@ -40,18 +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_TWITTER_KEY Twitter ``oauth_token`` -ASTAKOS_TWITTER_SECRET Twitter ``oauth_token_secret`` 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 ``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', 'twitter', '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`` @@ -61,9 +57,7 @@ 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 ASTAKOS_RECAPTCHA_OPTIONS {'theme': 'white'} Options for customizing reCAPTCHA look and feel @@ -74,7 +68,26 @@ ASTAKOS_BILLING_FIELDS ['id', 'is_active', 'provider', 'third_party ASTAKOS_QUEUE_CONNECTION The queue connection ex. 'rabbitmq://guest:guest@localhost:5672/astakos' (if it is not set, it does not send messages) ASTAKOS_RE_USER_EMAIL_PATTERNS [] Email patterns that are automatically activated ex. ['^[a-zA-Z0-9\._-]+@grnet\.gr$'] -============================== ============================================================================= =========================================================================================== + +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 + 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 ----------------------- @@ -84,12 +97,19 @@ Available as extensions to Django's command-line management utility: =============== =========================== Name Description =============== =========================== -activateuser Activates one or more users +addgroup Add new group +addterms Add new approval terms createuser Create a user inviteuser Invite a user +listgroups List groups listinvitations List invitations listusers List users modifyuser Modify a user's attributes +sendactivation Send activation email showinvitation Show invitation info 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.endpoints.aquarium.consumer.on_creditevent