README
======

Astakos is an identity management service, built by GRNET using Django (https://www.djangoproject.com/).
Learn more about Astakos at: http://code.grnet.gr/projects/astakos
Consult LICENSE for licensing information.

Documentation
-------------

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

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

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

Then run:
    python setup.py build_sphinx

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

Also run:
    python setup.py build_sphinx -b text

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

Running the server
------------------

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

Then run:
    python manage.py syncdb
    python manage.py migrate im
    python manage.py loaddata admin_user
    python manage.py runserver

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