Statistics
| Branch: | Tag: | Revision:

root / README @ 0c581627

History | View | Annotate | Download (1.6 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 ea313937 Antony Chazapis
    apt-get install python-django 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
Enter the pithos dir, copy settings.py.dist to settings.py.
20 5b61294c Antony Chazapis
21 5b61294c Antony Chazapis
Then run:
22 f2d7b5ab Antony Chazapis
    python setup.py build_sphinx
23 f2d7b5ab Antony Chazapis
24 3f839f59 Antony Chazapis
The documentation will be built in the docs/build/html directory.
25 f2d7b5ab Antony Chazapis
26 f2d7b5ab Antony Chazapis
Also run:
27 f2d7b5ab Antony Chazapis
    python setup.py build_sphinx -b text
28 f2d7b5ab Antony Chazapis
29 3f839f59 Antony Chazapis
Then find the plain text version of the docs in docs/build/text.
30 f2d7b5ab Antony Chazapis
31 f2d7b5ab Antony Chazapis
Running the server
32 f2d7b5ab Antony Chazapis
------------------
33 f2d7b5ab Antony Chazapis
34 5b61294c Antony Chazapis
Make sure you have all required packages installed:
35 ea313937 Antony Chazapis
    apt-get install python-django python-setuptools python-sphinx python-httplib2
36 ea313937 Antony Chazapis
    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
37 5b61294c Antony Chazapis
38 5b61294c Antony Chazapis
Enter the pithos dir, copy settings.py.dist to settings.py.
39 f4b61e0c Antony Chazapis
40 f4b61e0c Antony Chazapis
Then run:
41 7e318fc8 Antony Chazapis
    python manage.py syncdb
42 0c581627 Sofia Papagiannaki
    python manage.py schemamigration im --initial
43 ea313937 Antony Chazapis
    python manage.py loaddata admin_user
44 f2d7b5ab Antony Chazapis
    python manage.py runserver
45 f2d7b5ab Antony Chazapis
46 ea313937 Antony Chazapis
Go to:
47 ea313937 Antony Chazapis
	http://127.0.0.1:8000/im/admin?user=admin&token=0000
48 ea313937 Antony Chazapis
49 f2d7b5ab Antony Chazapis
This server is useful during development, but should not be used for deployment.
50 5b61294c Antony Chazapis
To deploy Pithos using Apache, take a look at the Administrator Guide in docs.