Commit e0bfcf77 authored by Antony Chazapis's avatar Antony Chazapis

Proper README.

parent ed0e6d77
Copyright 2011-2012 GRNET S.A. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and
documentation are those of the authors and should not be
interpreted as representing official policies, either expressed
or implied, of GRNET S.A.
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.
Copyright 2011 GRNET S.A. All rights reserved.
Copyright 2011-2012 GRNET S.A. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
......
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 COPYRIGHT for licensing information.
About Astakos application
-------------------------
This package contains the Django application that implements all identity management functions.
How to run
----------
Use snf-webproject to run Astakos automatically.
To use Astakos in a custom Django project, add ``astakos.im`` to ``INSTALLED_APPS``. Astakos requires South (http://south.aeracode.org/).
Also, add the following to your ``settings.py``::
TEMPLATE_CONTEXT_PROCESSORS = (
...
'astakos.im.context_processors.cloudbar',
'astakos.im.context_processors.im_modules',
'astakos.im.context_processors.next',
'astakos.im.context_processors.code',
'astakos.im.context_processors.invitations')
AUTHENTICATION_BACKENDS = ('astakos.im.auth_backends.EmailBackend',
'astakos.im.auth_backends.TokenBackend')
CUSTOM_USER_MODEL = 'astakos.im.AstakosUser'
LOGIN_URL = '/im'
Settings
--------
Configure in ``settings.py`` or a ``.conf`` file in ``/etc/synnefo`` if using snf-webproject.
=============================== ================================================ ============================================================
Name Default value Description
=============================== ================================================ ============================================================
...
=============================== ================================================ ============================================================
Administrator functions
-----------------------
Available as extensions to Django's command-line management utility:
============ ======================
Name Description
============ ======================
...
============ ======================
from django.conf import settings
from os.path import abspath, dirname, join
from urlparse import urlparse
# Set the expiration time of newly created auth tokens
# to be this many hours after their creation time.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment