Statistics
| Branch: | Tag: | Revision:

root / README @ 0f8ffac4

History | View | Annotate | Download (1.6 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
Enter the pithos dir, copy settings.py.dist to settings.py.
20

    
21
Then run:
22
    python setup.py build_sphinx
23

    
24
The documentation will be built in the docs/build/html directory.
25

    
26
Also run:
27
    python setup.py build_sphinx -b text
28

    
29
Then find the plain text version of the docs in docs/build/text.
30

    
31
Running the server
32
------------------
33

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

    
38
Enter the pithos dir, copy settings.py.dist to settings.py.
39

    
40
Then run:
41
    python manage.py syncdb
42
    python manage.py schemamigration im --initial
43
    python manage.py loaddata admin_user
44
    python manage.py runserver
45

    
46
Go to:
47
	http://127.0.0.1:8000/im/admin?user=admin&token=0000
48

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