Statistics
| Branch: | Tag: | Revision:

root / README @ c4af6d07

History | View | Annotate | Download (1.5 kB)

1
README
2
======
3

    
4
Pithos is a file storage service, built by GRNET using Django (https://www.djangoproject.com/).
5
Learn more about Pithos at: http://code.grnet.gr/projects/pithos
6
Consult LICENSE for licensing information.
7

    
8
Documentation
9
-------------
10

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

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

    
15
On a typical debian-based Linux system run:
16
    apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2
17
    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
18

    
19
Then run:
20
    python setup.py build_sphinx
21

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

    
24
Also run:
25
    python setup.py build_sphinx -b text
26

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

    
29
Running the server
30
------------------
31

    
32
Make sure you have all required packages installed:
33
    apt-get install python-django python-setuptools python-sphinx python-httplib2
34
    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
35

    
36
Then run:
37
    python manage.py syncdb
38
    python manage.py schemamigration im --initial
39
    python manage.py loaddata admin_user
40
    python manage.py runserver
41

    
42
Go to:
43
	http://127.0.0.1:8000/im/admin?user=admin&token=0000
44

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