Statistics
| Branch: | Tag: | Revision:

root / README @ 50f43df6

History | View | Annotate | Download (1.4 kB)

1
README
2
======
3

    
4
Pithos is a file storage service, built using Django (https://www.djangoproject.com/).
5
Consult LICENSE for licensing information.
6

    
7
Documentation
8
-------------
9

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

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

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

    
18
Enter the pithos dir, copy settings.py.dist to settings.py.
19

    
20
Then run:
21
    python setup.py build_sphinx
22

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

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

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

    
30
Running the server
31
------------------
32

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

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

    
39
Then run:
40
    python manage.py syncdb
41
    python manage.py loaddata im/fixtures/auth_test_data.json (to load sample users)
42
    python manage.py runserver
43

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