Statistics
| Branch: | Tag: | Revision:

root / README @ c4af6d07

History | View | Annotate | Download (1.5 kB)

1 5b61294c Antony Chazapis
README
2 5b61294c Antony Chazapis
======
3 5b61294c Antony Chazapis
4 ea313937 Antony Chazapis
Pithos is a file storage service, built by GRNET using Django (https://www.djangoproject.com/).
5 ea313937 Antony Chazapis
Learn more about Pithos at: http://code.grnet.gr/projects/pithos
6 5b61294c Antony Chazapis
Consult LICENSE for licensing information.
7 5b61294c Antony Chazapis
8 f2d7b5ab Antony Chazapis
Documentation
9 f2d7b5ab Antony Chazapis
-------------
10 f2d7b5ab Antony Chazapis
11 5b61294c Antony Chazapis
All docs are in the docs/source directory. The .rst files are perfectly readable in source form.
12 5b61294c Antony Chazapis
13 5b61294c Antony Chazapis
To build the documentation you need to have Sphinx (http://sphinx.pocoo.org/) installed.
14 5b61294c Antony Chazapis
15 5b61294c Antony Chazapis
On a typical debian-based Linux system run:
16 0f8ffac4 Antony Chazapis
    apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2
17 ea313937 Antony Chazapis
    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
18 f2d7b5ab Antony Chazapis
19 5b61294c Antony Chazapis
Then run:
20 f2d7b5ab Antony Chazapis
    python setup.py build_sphinx
21 f2d7b5ab Antony Chazapis
22 3f839f59 Antony Chazapis
The documentation will be built in the docs/build/html directory.
23 f2d7b5ab Antony Chazapis
24 f2d7b5ab Antony Chazapis
Also run:
25 f2d7b5ab Antony Chazapis
    python setup.py build_sphinx -b text
26 f2d7b5ab Antony Chazapis
27 3f839f59 Antony Chazapis
Then find the plain text version of the docs in docs/build/text.
28 f2d7b5ab Antony Chazapis
29 f2d7b5ab Antony Chazapis
Running the server
30 f2d7b5ab Antony Chazapis
------------------
31 f2d7b5ab Antony Chazapis
32 5b61294c Antony Chazapis
Make sure you have all required packages installed:
33 ea313937 Antony Chazapis
    apt-get install python-django python-setuptools python-sphinx python-httplib2
34 ea313937 Antony Chazapis
    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
35 5b61294c Antony Chazapis
36 f4b61e0c Antony Chazapis
Then run:
37 7e318fc8 Antony Chazapis
    python manage.py syncdb
38 0c581627 Sofia Papagiannaki
    python manage.py schemamigration im --initial
39 ea313937 Antony Chazapis
    python manage.py loaddata admin_user
40 f2d7b5ab Antony Chazapis
    python manage.py runserver
41 f2d7b5ab Antony Chazapis
42 ea313937 Antony Chazapis
Go to:
43 ea313937 Antony Chazapis
	http://127.0.0.1:8000/im/admin?user=admin&token=0000
44 ea313937 Antony Chazapis
45 f2d7b5ab Antony Chazapis
This server is useful during development, but should not be used for deployment.
46 5b61294c Antony Chazapis
To deploy Pithos using Apache, take a look at the Administrator Guide in docs.