4 Astakos is an identity management service, built by GRNET using Django (https://www.djangoproject.com/).
5 Learn more about Astakos at: http://code.grnet.gr/projects/astakos
7 Consult COPYRIGHT for licensing information.
9 About Astakos application
10 -------------------------
12 This package contains the Django application that implements all identity management functions.
17 Use snf-webproject to run Astakos automatically.
19 To use Astakos in a custom Django project, add ``astakos.im`` to ``INSTALLED_APPS``. Astakos requires South (http://south.aeracode.org/).
21 Also, add the following to your ``settings.py``::
23 TEMPLATE_CONTEXT_PROCESSORS = (
25 'astakos.im.context_processors.cloudbar',
26 'astakos.im.context_processors.im_modules',
27 'astakos.im.context_processors.next',
28 'astakos.im.context_processors.code',
29 'astakos.im.context_processors.invitations')
31 AUTHENTICATION_BACKENDS = ('astakos.im.auth_backends.EmailBackend',
32 'astakos.im.auth_backends.TokenBackend')
34 CUSTOM_USER_MODEL = 'astakos.im.AstakosUser'
41 Configure in ``settings.py`` or a ``.conf`` file in ``/etc/synnefo`` if using snf-webproject.
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_CLOUD_SERVICES ({'icon': 'home-icon.png', 'id': 'cloud', 'name': 'grnet cloud', 'url': '/'}, Cloud services appear in the horizontal bar
63 {'id': 'okeanos', 'name': 'cyclades', 'url': '/okeanos.html'},
64 {'id': 'pithos', 'name': 'pithos+', 'url': '/ui/'})
65 ASTAKOS_RECAPTCHA_ENABLED True Enable recaptcha
66 ASTAKOS_RECAPTCHA_PUBLIC_KEY Recaptcha public key obtained after registration here: http://recaptcha.net
67 ASTAKOS_RECAPTCHA_PRIVATE_KEY Recaptcha private key obtained after registration here: http://recaptcha.net
68 ASTAKOS_RECAPTCHA_OPTIONS {'theme': 'white'} Options for customizing reCAPTCHA look and feel
69 (see: http://code.google.com/intl/el-GR/apis/recaptcha/docs/customization.html)
70 ASTAKOS_LOGOUT_NEXT Where the user should be redirected after logout
71 (if not set and no next parameter is defined it renders login page with message)
72 ASTAKOS_BILLING_FIELDS ['id', 'is_active', 'provider', 'third_party_identifier'] AstakosUser fields to propagate in the billing system
73 ASTAKOS_QUEUE_CONNECTION The queue connection ex. 'rabbitmq://guest:guest@localhost:5672/astakos'
74 (if it is not set, it does not send messages)
75 ASTAKOS_RE_USER_EMAIL_PATTERNS [] Email patterns that are automatically activated ex. ['^[a-zA-Z0-9\._-]+@grnet\.gr$']
77 ASTAKOS_LOGIN_MESSAGES {} Notification messages to display on login page header
78 e.g. {'warning': 'Warning message (can contain html)'}
79 ASTAKOS_PROFILE_EXTRA_LINKS {} Messages to display as extra actions in account forms
80 e.g. {'https://cms.okeanos.grnet.gr/': 'Back to ~okeanos'}
81 ASTAKOS_RATELIMIT_RETRIES_ALLOWED 3 Number of unsuccessful login requests per minute allowed for a specific account.
82 When this number exceeds and ASTAKOS_RECAPTCHA_ENABLED is set the user has to solve a
84 ASTAKOS_EMAILCHANGE_ENABLED False Enable email change mechanism
85 ASTAKOS_EMAILCHANGE_ACTIVATION_DAYS 10 Number of days that email change requests remain active
86 =================================== ============================================================================= ===========================================================================================
88 Administrator functions
89 -----------------------
91 Available as extensions to Django's command-line management utility:
93 =============== ===========================
95 =============== ===========================
96 addgroup Add new group
97 addterms Add new approval terms
98 createuser Create a user
99 inviteuser Invite a user
100 listgroups List groups
101 listinvitations List invitations
103 modifyuser Modify a user's attributes
104 sendactivation Send activation email
105 showinvitation Show invitation info
106 showuser Show user info
107 =============== ===========================
109 To update user credibility from the billing system (Aquarium), enable the queue, install snf-pithos-tools and use ``pithos-dispatcher``::
111 pithos-dispatcher --exchange=aquarium --callback=astakos.im.queue.listener.on_creditevent
116 To set the initial user groups load the followind fixture:
118 snf-manage loaddata groups