root / README @ d58ac891
History | View | Annotate | Download (2 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 | 5d56107c | Antony Chazapis | apt-get install python-django python-setuptools python-sphinx |
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 | 5d56107c | Antony Chazapis | apt-get install python-django python-setuptools python-sphinx |
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 | f2d7b5ab | Antony Chazapis | python manage.py runserver |
39 | f2d7b5ab | Antony Chazapis | |
40 | f2d7b5ab | Antony Chazapis | This server is useful during development, but should not be used for deployment. |
41 | 5b61294c | Antony Chazapis | To deploy Pithos using Apache, take a look at the Administrator Guide in docs. |
42 | 5a96180b | Antony Chazapis | |
43 | 5a96180b | Antony Chazapis | Using the tools |
44 | 5a96180b | Antony Chazapis | --------------- |
45 | 5a96180b | Antony Chazapis | |
46 | 5a96180b | Antony Chazapis | In the pithos/tools directory you will find the following utilities: |
47 | 5a96180b | Antony Chazapis | |
48 | 5a96180b | Antony Chazapis | pithos-sh Pithos shell |
49 | 5a96180b | Antony Chazapis | pithos-sync Pithos synchronization client |
50 | 5a96180b | Antony Chazapis | pithos-fs Pithos FUSE implementation |
51 | 5a96180b | Antony Chazapis | pithos-test Pithos server tests |
52 | 5a96180b | Antony Chazapis | |
53 | 5a96180b | Antony Chazapis | Also, the pithos/lib directory contains a python library that can be used |
54 | 5a96180b | Antony Chazapis | to access Pithos and manage stored objects. All tools use the included lib. |
55 | 5a96180b | Antony Chazapis | |
56 | 5a96180b | Antony Chazapis | Connection options can be set via environmental variables: |
57 | 5a96180b | Antony Chazapis | |
58 | 5a96180b | Antony Chazapis | PITHOS_USER Login user |
59 | 5a96180b | Antony Chazapis | PITHOS_AUTH Login token |
60 | 5a96180b | Antony Chazapis | PITHOS_SERVER Pithos server (default: plus.pithos.grnet.gr) |
61 | 5a96180b | Antony Chazapis | PITHOS_API Pithos server path (default: v1) |
62 | 5a96180b | Antony Chazapis | PITHOS_SYNC_CONTAINER Container to sync with (default: pithos) |