X-Git-Url: https://code.grnet.gr/git/pithos/blobdiff_plain/ea31393726d531d113ad5a253018731f9b3cf46a..a903e505357b94a27c253778e4e18b6784e62ddf:/README diff --git a/README b/README index 0b4c4be..ddee9dd 100644 --- a/README +++ b/README @@ -13,11 +13,9 @@ All docs are in the docs/source directory. The .rst files are perfectly readable To build the documentation you need to have Sphinx (http://sphinx.pocoo.org/) installed. On a typical debian-based Linux system run: - apt-get install python-django python-setuptools python-sphinx python-httplib2 + apt-get install python-django python-setuptools python-sphinx apt-get install python-sqlalchemy python-mysqldb python-psycopg2 -Enter the pithos dir, copy settings.py.dist to settings.py. - Then run: python setup.py build_sphinx @@ -32,18 +30,33 @@ Running the server ------------------ Make sure you have all required packages installed: - apt-get install python-django python-setuptools python-sphinx python-httplib2 + apt-get install python-django python-setuptools python-sphinx apt-get install python-sqlalchemy python-mysqldb python-psycopg2 -Enter the pithos dir, copy settings.py.dist to settings.py. - Then run: python manage.py syncdb - python manage.py loaddata admin_user python manage.py runserver -Go to: - http://127.0.0.1:8000/im/admin?user=admin&token=0000 - This server is useful during development, but should not be used for deployment. To deploy Pithos using Apache, take a look at the Administrator Guide in docs. + +Using the tools +--------------- + +In the pithos/tools directory you will find the following utilities: + + pithos-sh Pithos shell + pithos-sync Pithos synchronization client + pithos-fs Pithos FUSE implementation + pithos-test Pithos server tests + +Also, the pithos/lib directory contains a python library that can be used +to access Pithos and manage stored objects. All tools use the included lib. + +Connection options can be set via environmental variables: + + PITHOS_USER Login user + PITHOS_AUTH Login token + PITHOS_SERVER Pithos server (default: plus.pithos.grnet.gr) + PITHOS_API Pithos server path (default: v1) + PITHOS_SYNC_CONTAINER Container to sync with (default: pithos)