code.grnet.gr Git - pithos/blob - README

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