root / README @ 8ed29e14
History | View | Annotate | Download (1.3 kB)
1 | 64cd4730 | Antony Chazapis | README |
---|---|---|---|
2 | 64cd4730 | Antony Chazapis | ====== |
3 | 64cd4730 | Antony Chazapis | |
4 | 64cd4730 | Antony Chazapis | Astakos is an identity management service, built by GRNET using Django (https://www.djangoproject.com/). |
5 | 64cd4730 | Antony Chazapis | Learn more about Astakos at: http://code.grnet.gr/projects/astakos |
6 | 64cd4730 | Antony Chazapis | Consult LICENSE for licensing information. |
7 | 64cd4730 | Antony Chazapis | |
8 | 64cd4730 | Antony Chazapis | Documentation |
9 | 64cd4730 | Antony Chazapis | ------------- |
10 | 64cd4730 | Antony Chazapis | |
11 | 64cd4730 | Antony Chazapis | All docs are in the docs/source directory. The .rst files are perfectly readable in source form. |
12 | 64cd4730 | Antony Chazapis | |
13 | 64cd4730 | Antony Chazapis | To build the documentation you need to have Sphinx (http://sphinx.pocoo.org/) installed. |
14 | 64cd4730 | Antony Chazapis | |
15 | 64cd4730 | Antony Chazapis | On a typical debian-based Linux system run: |
16 | 64cd4730 | Antony Chazapis | apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2 |
17 | 64cd4730 | Antony Chazapis | |
18 | 64cd4730 | Antony Chazapis | Then run: |
19 | 64cd4730 | Antony Chazapis | python setup.py build_sphinx |
20 | 64cd4730 | Antony Chazapis | |
21 | 64cd4730 | Antony Chazapis | The documentation will be built in the docs/build/html directory. |
22 | 64cd4730 | Antony Chazapis | |
23 | 64cd4730 | Antony Chazapis | Also run: |
24 | 64cd4730 | Antony Chazapis | python setup.py build_sphinx -b text |
25 | 64cd4730 | Antony Chazapis | |
26 | 64cd4730 | Antony Chazapis | Then find the plain text version of the docs in docs/build/text. |
27 | 64cd4730 | Antony Chazapis | |
28 | 64cd4730 | Antony Chazapis | Running the server |
29 | 64cd4730 | Antony Chazapis | ------------------ |
30 | 64cd4730 | Antony Chazapis | |
31 | 64cd4730 | Antony Chazapis | Make sure you have all required packages installed: |
32 | 794852f2 | Sofia Papagiannaki | apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2 |
33 | 64cd4730 | Antony Chazapis | |
34 | 64cd4730 | Antony Chazapis | Then run: |
35 | 64cd4730 | Antony Chazapis | python manage.py syncdb |
36 | 64cd4730 | Antony Chazapis | python manage.py migrate im |
37 | 64cd4730 | Antony Chazapis | python manage.py loaddata admin_user |
38 | 64cd4730 | Antony Chazapis | python manage.py runserver |
39 | 64cd4730 | Antony Chazapis | |
40 | 64cd4730 | Antony Chazapis | This server is useful during development, but should not be used for deployment. |
41 | 64cd4730 | Antony Chazapis | To deploy Astakos using Apache, take a look at the Administrator Guide in docs. |