Statistics
| Branch: | Tag: | Revision:

root / README @ 794852f2

History | View | Annotate | Download (1.4 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
Consult LICENSE for licensing information.
7

    
8
Documentation
9
-------------
10

    
11
All docs are in the docs/source directory. The .rst files are perfectly readable in source form.
12

    
13
To build the documentation you need to have Sphinx (http://sphinx.pocoo.org/) installed.
14

    
15
On a typical debian-based Linux system run:
16
    apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2
17

    
18
Then run:
19
    python setup.py build_sphinx
20

    
21
The documentation will be built in the docs/build/html directory.
22

    
23
Also run:
24
    python setup.py build_sphinx -b text
25

    
26
Then find the plain text version of the docs in docs/build/text.
27

    
28
Running the server
29
------------------
30

    
31
Make sure you have all required packages installed:
32
    apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2
33

    
34
Then run:
35
    python manage.py syncdb
36
    python manage.py migrate im
37
    python manage.py loaddata admin_user
38
    python manage.py runserver
39

    
40
Go to:
41
	http://127.0.0.1:8000/im/admin?user=admin&token=0000
42

    
43
This server is useful during development, but should not be used for deployment.
44
To deploy Astakos using Apache, take a look at the Administrator Guide in docs.