Revision b03877be snf-astakos-app/README
b/snf-astakos-app/README | ||
---|---|---|
40 | 40 |
|
41 | 41 |
Configure in ``settings.py`` or a ``.conf`` file in ``/etc/synnefo`` if using snf-webproject. |
42 | 42 |
|
43 |
=================================== ============================================================================= =========================================================================================== |
|
44 |
Name Default value Description |
|
45 |
=================================== ============================================================================= =========================================================================================== |
|
46 |
ASTAKOS_AUTH_TOKEN_DURATION one month Expiration time of newly created auth tokens |
|
47 |
ASTAKOS_DEFAULT_USER_LEVEL 4 Default (not-invited) user level |
|
48 |
ASTAKOS_INVITATIONS_PER_LEVEL {0:100, 1:2, 2:0, 3:0, 4:0} Number of user invitations per user level |
|
49 |
ASTAKOS_DEFAULT_FROM_EMAIL GRNET Cloud <no-reply\@grnet.gr> ``from`` parameter passed in ``django.core.mail.send_mail`` |
|
50 |
ASTAKOS_DEFAULT_CONTACT_EMAIL support\@cloud.grnet.gr Contact email |
|
51 |
ASTAKOS_DEFAULT_ADMIN_EMAIL support\@cloud.grnet.gr Administrator email to receive user creation notifications (if None disables notifications) |
|
52 |
ASTAKOS_IM_MODULES ['local', 'shibboleth'] Signup modules |
|
53 |
ASTAKOS_FORCE_PROFILE_UPDATE True Force user profile verification |
|
54 |
ASTAKOS_INVITATIONS_ENABLED True Enable invitations |
|
55 |
ASTAKOS_COOKIE_NAME _pithos2_a ``Key`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
|
56 |
ASTAKOS_COOKIE_DOMAIN None ``Domain`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
|
57 |
ASTAKOS_COOKIE_SECURE True ``Secure`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
|
58 |
ASTAKOS_IM_STATIC_URL /static/im/ URL to use when referring to static files |
|
59 |
ASTAKOS_MODERATION_ENABLED True If False and invitations are not enabled newly created user will be automatically accepted |
|
60 |
ASTAKOS_BASEURL \http://pithos.dev.grnet.gr Astakos baseurl |
|
61 |
ASTAKOS_SITENAME GRNET Cloud Service name that appears in emails |
|
62 |
ASTAKOS_RECAPTCHA_ENABLED True Enable recaptcha |
|
63 |
ASTAKOS_RECAPTCHA_PUBLIC_KEY Recaptcha public key obtained after registration here: http://recaptcha.net |
|
64 |
ASTAKOS_RECAPTCHA_PRIVATE_KEY Recaptcha private key obtained after registration here: http://recaptcha.net |
|
65 |
ASTAKOS_RECAPTCHA_OPTIONS {'theme': 'white'} Options for customizing reCAPTCHA look and feel |
|
66 |
(see: http://code.google.com/intl/el-GR/apis/recaptcha/docs/customization.html) |
|
67 |
ASTAKOS_LOGOUT_NEXT Where the user should be redirected after logout |
|
68 |
(if not set and no next parameter is defined it renders login page with message) |
|
69 |
ASTAKOS_BILLING_FIELDS ['id', 'is_active', 'provider', 'third_party_identifier'] AstakosUser fields to propagate in the billing system |
|
70 |
ASTAKOS_QUEUE_CONNECTION The queue connection ex. 'rabbitmq://guest:guest@localhost:5672/astakos' |
|
71 |
(if it is not set, it does not send messages) |
|
72 |
ASTAKOS_RE_USER_EMAIL_PATTERNS [] Email patterns that are automatically activated ex. ['^[a-zA-Z0-9\._-]+@grnet\.gr$'] |
|
73 |
|
|
74 |
ASTAKOS_LOGIN_MESSAGES {} Notification messages to display on login page header |
|
75 |
e.g. {'warning': 'Warning message (can contain html)'} |
|
76 |
ASTAKOS_PROFILE_EXTRA_LINKS {} Messages to display as extra actions in account forms |
|
77 |
e.g. {'https://cms.okeanos.grnet.gr/': 'Back to ~okeanos'} |
|
78 |
ASTAKOS_RATELIMIT_RETRIES_ALLOWED 3 Number of unsuccessful login requests per minute allowed for a specific account. |
|
79 |
When this number exceeds and ASTAKOS_RECAPTCHA_ENABLED is set the user has to solve a |
|
80 |
captcha challenge. |
|
81 |
ASTAKOS_EMAILCHANGE_ENABLED False Enable email change mechanism |
|
82 |
ASTAKOS_EMAILCHANGE_ACTIVATION_DAYS 10 Number of days that email change requests remain active |
|
83 |
ASTAKOS_LOGGING_LEVEL INFO Message logging severity |
|
84 |
=================================== ============================================================================= =========================================================================================== |
|
43 |
=========================================== ============================================================================= =========================================================================================== |
|
44 |
Name Default value Description |
|
45 |
=========================================== ============================================================================= =========================================================================================== |
|
46 |
ASTAKOS_AUTH_TOKEN_DURATION one month Expiration time of newly created auth tokens |
|
47 |
ASTAKOS_DEFAULT_USER_LEVEL 4 Default (not-invited) user level |
|
48 |
ASTAKOS_INVITATIONS_PER_LEVEL {0:100, 1:2, 2:0, 3:0, 4:0} Number of user invitations per user level |
|
49 |
ASTAKOS_DEFAULT_FROM_EMAIL GRNET Cloud <no-reply\@grnet.gr> ``from`` parameter passed in ``django.core.mail.send_mail`` |
|
50 |
ASTAKOS_DEFAULT_CONTACT_EMAIL support\@cloud.grnet.gr Contact email |
|
51 |
ASTAKOS_DEFAULT_ADMIN_EMAIL support\@cloud.grnet.gr Administrator email to receive user creation notifications (if None disables notifications) |
|
52 |
ASTAKOS_IM_MODULES ['local', 'shibboleth'] Signup modules |
|
53 |
ASTAKOS_FORCE_PROFILE_UPDATE True Force user profile verification |
|
54 |
ASTAKOS_INVITATIONS_ENABLED True Enable invitations |
|
55 |
ASTAKOS_COOKIE_NAME _pithos2_a ``Key`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
|
56 |
ASTAKOS_COOKIE_DOMAIN None ``Domain`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
|
57 |
ASTAKOS_COOKIE_SECURE True ``Secure`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
|
58 |
ASTAKOS_IM_STATIC_URL /static/im/ URL to use when referring to static files |
|
59 |
ASTAKOS_MODERATION_ENABLED True If False and invitations are not enabled newly created user will be automatically accepted |
|
60 |
ASTAKOS_BASEURL \http://pithos.dev.grnet.gr Astakos baseurl |
|
61 |
ASTAKOS_SITENAME GRNET Cloud Service name that appears in emails |
|
62 |
ASTAKOS_RECAPTCHA_ENABLED True Enable recaptcha |
|
63 |
ASTAKOS_RECAPTCHA_PUBLIC_KEY Recaptcha public key obtained after registration here: http://recaptcha.net |
|
64 |
ASTAKOS_RECAPTCHA_PRIVATE_KEY Recaptcha private key obtained after registration here: http://recaptcha.net |
|
65 |
ASTAKOS_RECAPTCHA_OPTIONS {'theme': 'white'} Options for customizing reCAPTCHA look and feel |
|
66 |
(see: http://code.google.com/intl/el-GR/apis/recaptcha/docs/customization.html) |
|
67 |
ASTAKOS_LOGOUT_NEXT Where the user should be redirected after logout |
|
68 |
(if not set and no next parameter is defined it renders login page with message) |
|
69 |
ASTAKOS_BILLING_FIELDS ['id', 'is_active', 'provider', 'third_party_identifier'] AstakosUser fields to propagate in the billing system |
|
70 |
ASTAKOS_QUEUE_CONNECTION The queue connection ex. 'rabbitmq://guest:guest@localhost:5672/astakos' |
|
71 |
(if it is not set, it does not send messages) |
|
72 |
ASTAKOS_RE_USER_EMAIL_PATTERNS [] Email patterns that are automatically activated ex. ['^[a-zA-Z0-9\._-]+@grnet\.gr$'] |
|
73 |
|
|
74 |
ASTAKOS_LOGIN_MESSAGES {} Notification messages to display on login page header |
|
75 |
e.g. {'warning': 'Warning message (can contain html)'} |
|
76 |
ASTAKOS_PROFILE_EXTRA_LINKS {} Messages to display as extra actions in account forms |
|
77 |
e.g. {'https://cms.okeanos.grnet.gr/': 'Back to ~okeanos'} |
|
78 |
ASTAKOS_RATELIMIT_RETRIES_ALLOWED 3 Number of unsuccessful login requests per minute allowed for a specific account. |
|
79 |
When this number exceeds and ASTAKOS_RECAPTCHA_ENABLED is set the user has to solve a |
|
80 |
captcha challenge. |
|
81 |
ASTAKOS_EMAILCHANGE_ENABLED False Enable email change mechanism |
|
82 |
ASTAKOS_EMAILCHANGE_ACTIVATION_DAYS 10 Number of days that email change requests remain active |
|
83 |
ASTAKOS_LOGGING_LEVEL INFO Message logging severity |
|
84 |
ASTAKOS_INVITATION_EMAIL_SUBJECT 'Invitation to %s alpha2 testing' % SITENAME Invitation email subject |
|
85 |
ASTAKOS_GREETING_EMAIL_SUBJECT 'Welcome to %s alpha2 testing' % SITENAME Welcome email subject |
|
86 |
ASTAKOS_FEEDBACK_EMAIL_SUBJECT 'Feedback from %s alpha2 testing' % SITENAME Feedback email subject |
|
87 |
ASTAKOS_VERIFICATION_EMAIL_SUBJECT '%s alpha2 testing account activation is needed' % SITENAME Account activation email subject |
|
88 |
ASTAKOS_ADMIN_NOTIFICATION_EMAIL_SUBJECT '%s alpha2 testing account created (%%(user)s)' % SITENAME Account creation admin notification email subject |
|
89 |
ASTAKOS_HELPDESK_NOTIFICATION_EMAIL_SUBJECT '%s alpha2 testing account activated (%%(user)s)' % SITENAME Account activation helpdesk notification email subject |
|
90 |
ASTAKOS_EMAIL_CHANGE_EMAIL_SUBJECT 'Email change on %s alpha2 testing' % SITENAME Email change subject |
|
91 |
ASTAKOS_PASSWORD_RESET_EMAIL_SUBJECT 'Password reset on %s alpha2 testing' % SITENAME Password change email subject |
|
92 |
=========================================== ============================================================================= =========================================================================================== |
|
85 | 93 |
|
86 | 94 |
Administrator functions |
87 | 95 |
----------------------- |
Also available in: Unified diff