root / snf-astakos-app / README @ 522cf8cb
History | View | Annotate | Download (7 kB)
1 | e0bfcf77 | Antony Chazapis | README |
---|---|---|---|
2 | e0bfcf77 | Antony Chazapis | ====== |
3 | e0bfcf77 | Antony Chazapis | |
4 | e0bfcf77 | Antony Chazapis | Astakos is an identity management service, built by GRNET using Django (https://www.djangoproject.com/). |
5 | e0bfcf77 | Antony Chazapis | Learn more about Astakos at: http://code.grnet.gr/projects/astakos |
6 | e0bfcf77 | Antony Chazapis | |
7 | e0bfcf77 | Antony Chazapis | Consult COPYRIGHT for licensing information. |
8 | e0bfcf77 | Antony Chazapis | |
9 | e0bfcf77 | Antony Chazapis | About Astakos application |
10 | e0bfcf77 | Antony Chazapis | ------------------------- |
11 | e0bfcf77 | Antony Chazapis | |
12 | e0bfcf77 | Antony Chazapis | This package contains the Django application that implements all identity management functions. |
13 | e0bfcf77 | Antony Chazapis | |
14 | e0bfcf77 | Antony Chazapis | How to run |
15 | e0bfcf77 | Antony Chazapis | ---------- |
16 | e0bfcf77 | Antony Chazapis | |
17 | e0bfcf77 | Antony Chazapis | Use snf-webproject to run Astakos automatically. |
18 | e0bfcf77 | Antony Chazapis | |
19 | e0bfcf77 | Antony Chazapis | To use Astakos in a custom Django project, add ``astakos.im`` to ``INSTALLED_APPS``. Astakos requires South (http://south.aeracode.org/). |
20 | e0bfcf77 | Antony Chazapis | |
21 | e0bfcf77 | Antony Chazapis | Also, add the following to your ``settings.py``:: |
22 | e0bfcf77 | Antony Chazapis | |
23 | e0bfcf77 | Antony Chazapis | TEMPLATE_CONTEXT_PROCESSORS = ( |
24 | e0bfcf77 | Antony Chazapis | ... |
25 | e0bfcf77 | Antony Chazapis | 'astakos.im.context_processors.cloudbar', |
26 | e0bfcf77 | Antony Chazapis | 'astakos.im.context_processors.im_modules', |
27 | e0bfcf77 | Antony Chazapis | 'astakos.im.context_processors.next', |
28 | e0bfcf77 | Antony Chazapis | 'astakos.im.context_processors.code', |
29 | e0bfcf77 | Antony Chazapis | 'astakos.im.context_processors.invitations') |
30 | e0bfcf77 | Antony Chazapis | |
31 | e0bfcf77 | Antony Chazapis | AUTHENTICATION_BACKENDS = ('astakos.im.auth_backends.EmailBackend', |
32 | e0bfcf77 | Antony Chazapis | 'astakos.im.auth_backends.TokenBackend') |
33 | e0bfcf77 | Antony Chazapis | |
34 | e0bfcf77 | Antony Chazapis | CUSTOM_USER_MODEL = 'astakos.im.AstakosUser' |
35 | e0bfcf77 | Antony Chazapis | |
36 | e0bfcf77 | Antony Chazapis | LOGIN_URL = '/im' |
37 | e0bfcf77 | Antony Chazapis | |
38 | e0bfcf77 | Antony Chazapis | Settings |
39 | e0bfcf77 | Antony Chazapis | -------- |
40 | e0bfcf77 | Antony Chazapis | |
41 | e0bfcf77 | Antony Chazapis | Configure in ``settings.py`` or a ``.conf`` file in ``/etc/synnefo`` if using snf-webproject. |
42 | e0bfcf77 | Antony Chazapis | |
43 | a9281516 | Sofia Papagiannaki | ============================== ============================================================================= =========================================================================================== |
44 | a9281516 | Sofia Papagiannaki | Name Default value Description |
45 | a9281516 | Sofia Papagiannaki | ============================== ============================================================================= =========================================================================================== |
46 | a9281516 | Sofia Papagiannaki | ASTAKOS_AUTH_TOKEN_DURATION one month Expiration time of newly created auth tokens |
47 | a9281516 | Sofia Papagiannaki | ASTAKOS_TWITTER_KEY Twitter ``oauth_token`` |
48 | a9281516 | Sofia Papagiannaki | ASTAKOS_TWITTER_SECRET Twitter ``oauth_token_secret`` |
49 | a9281516 | Sofia Papagiannaki | ASTAKOS_DEFAULT_USER_LEVEL 4 Default (not-invited) user level |
50 | a9281516 | Sofia Papagiannaki | ASTAKOS_INVITATIONS_PER_LEVEL {0:100, 1:2, 2:0, 3:0, 4:0} Number of user invitations per user level |
51 | a9281516 | Sofia Papagiannaki | ASTAKOS_DEFAULT_FROM_EMAIL GRNET Cloud <no-reply\@grnet.gr> ``from`` parameter passed in ``django.core.mail.send_mail`` |
52 | a9281516 | Sofia Papagiannaki | ASTAKOS_DEFAULT_CONTACT_EMAIL support\@cloud.grnet.gr Contact email |
53 | b38e85ae | Sofia Papagiannaki | ASTAKOS_DEFAULT_ADMIN_EMAIL support\@cloud.grnet.gr Administrator email to receive user creation notifications (if None disables notifications) |
54 | a9281516 | Sofia Papagiannaki | ASTAKOS_IM_MODULES ['local', 'twitter', 'shibboleth'] Signup modules |
55 | a9281516 | Sofia Papagiannaki | ASTAKOS_FORCE_PROFILE_UPDATE True Force user profile verification |
56 | a9281516 | Sofia Papagiannaki | ASTAKOS_INVITATIONS_ENABLED True Enable invitations |
57 | a9281516 | Sofia Papagiannaki | ASTAKOS_COOKIE_NAME _pithos2_a ``Key`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
58 | a9281516 | Sofia Papagiannaki | ASTAKOS_COOKIE_DOMAIN None ``Domain`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
59 | a9281516 | Sofia Papagiannaki | ASTAKOS_COOKIE_SECURE True ``Secure`` parameter passed in ``django.http.HttpResponse.set_cookie`` |
60 | a9281516 | Sofia Papagiannaki | ASTAKOS_IM_STATIC_URL /static/im/ URL to use when referring to static files |
61 | a9281516 | Sofia Papagiannaki | ASTAKOS_MODERATION_ENABLED True If False and invitations are not enabled newly created user will be automatically accepted |
62 | a9281516 | Sofia Papagiannaki | ASTAKOS_BASEURL \http://pithos.dev.grnet.gr Astakos baseurl |
63 | a9281516 | Sofia Papagiannaki | ASTAKOS_SITENAME GRNET Cloud Service name that appears in emails |
64 | a9281516 | Sofia Papagiannaki | ASTAKOS_CLOUD_SERVICES ({'icon': 'home-icon.png', 'id': 'cloud', 'name': 'grnet cloud', 'url': '/'}, Cloud services appear in the horizontal bar |
65 | 0d02a287 | Sofia Papagiannaki | {'id': 'okeanos', 'name': 'cyclades', 'url': '/okeanos.html'}, |
66 | a9281516 | Sofia Papagiannaki | {'id': 'pithos', 'name': 'pithos+', 'url': '/ui/'}) |
67 | f2cee255 | Sofia Papagiannaki | ASTAKOS_RECAPTCHA_PUBLIC_KEY Recaptcha public key obtained after registration here: http://recaptcha.net |
68 | f2cee255 | Sofia Papagiannaki | ASTAKOS_RECAPTCHA_PRIVATE_KEY Recaptcha private key obtained after registration here: http://recaptcha.net |
69 | 0d02a287 | Sofia Papagiannaki | ASTAKOS_RECAPTCHA_OPTIONS {'theme': 'white'} Options for customizing reCAPTCHA look and feel |
70 | 0d02a287 | Sofia Papagiannaki | (see: http://code.google.com/intl/el-GR/apis/recaptcha/docs/customization.html) |
71 | 0d02a287 | Sofia Papagiannaki | ASTAKOS_LOGOUT_NEXT Where the user should be redirected after logout |
72 | 0d02a287 | Sofia Papagiannaki | (if not set and no next parameter is defined it renders login page with message) |
73 | 8316698a | Sofia Papagiannaki | ASTAKOS_RE_USER_EMAIL_PATTERNS [] Email patterns that are automatically activated ex. ['^[a-zA-Z0-9\._-]+@grnet\.gr$'] |
74 | a9281516 | Sofia Papagiannaki | ============================== ============================================================================= =========================================================================================== |
75 | e0bfcf77 | Antony Chazapis | |
76 | e0bfcf77 | Antony Chazapis | Administrator functions |
77 | e0bfcf77 | Antony Chazapis | ----------------------- |
78 | e0bfcf77 | Antony Chazapis | |
79 | e0bfcf77 | Antony Chazapis | Available as extensions to Django's command-line management utility: |
80 | e0bfcf77 | Antony Chazapis | |
81 | d01e7b22 | Antony Chazapis | =============== =========================== |
82 | d01e7b22 | Antony Chazapis | Name Description |
83 | d01e7b22 | Antony Chazapis | =============== =========================== |
84 | d01e7b22 | Antony Chazapis | activateuser Activates one or more users |
85 | d01e7b22 | Antony Chazapis | createuser Create a user |
86 | d01e7b22 | Antony Chazapis | inviteuser Invite a user |
87 | d01e7b22 | Antony Chazapis | listinvitations List invitations |
88 | d01e7b22 | Antony Chazapis | listusers List users |
89 | d01e7b22 | Antony Chazapis | modifyuser Modify a user's attributes |
90 | d01e7b22 | Antony Chazapis | showinvitation Show invitation info |
91 | d01e7b22 | Antony Chazapis | showuser Show user info |
92 | d01e7b22 | Antony Chazapis | =============== =========================== |