Statistics
| Branch: | Tag: | Revision:

root / snf-astakos-app / README @ d01e7b22

History | View | Annotate | Download (2.3 kB)

1
README
2
======
3

    
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
6

    
7
Consult COPYRIGHT for licensing information.
8

    
9
About Astakos application
10
-------------------------
11

    
12
This package contains the Django application that implements all identity management functions.
13

    
14
How to run
15
----------
16

    
17
Use snf-webproject to run Astakos automatically.
18

    
19
To use Astakos in a custom Django project, add ``astakos.im`` to ``INSTALLED_APPS``. Astakos requires South (http://south.aeracode.org/).
20

    
21
Also, add the following to your ``settings.py``::
22

    
23
    TEMPLATE_CONTEXT_PROCESSORS = (
24
        ...
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')
30
    
31
    AUTHENTICATION_BACKENDS = ('astakos.im.auth_backends.EmailBackend',
32
                               'astakos.im.auth_backends.TokenBackend')
33
    
34
    CUSTOM_USER_MODEL = 'astakos.im.AstakosUser'
35
    
36
    LOGIN_URL = '/im'
37

    
38
Settings
39
--------
40

    
41
Configure in ``settings.py`` or a ``.conf`` file in ``/etc/synnefo`` if using snf-webproject.
42

    
43
===============================  ================================================  ============================================================
44
Name                             Default value                                     Description
45
===============================  ================================================  ============================================================
46
...
47
===============================  ================================================  ============================================================
48

    
49
Administrator functions
50
-----------------------
51

    
52
Available as extensions to Django's command-line management utility:
53

    
54
===============  ===========================
55
Name             Description
56
===============  ===========================
57
activateuser     Activates one or more users
58
createuser       Create a user
59
inviteuser       Invite a user
60
listinvitations  List invitations
61
listusers        List users
62
modifyuser       Modify a user's attributes
63
showinvitation   Show invitation info
64
showuser         Show user info
65
===============  ===========================