X-Git-Url: https://code.grnet.gr/git/pithos/blobdiff_plain/f4b61e0ce703900c93d614fe0282b588cde77145..fb0640327aaf0fb573ad04ad6ddc3fef3e57fd13:/README diff --git a/README b/README index 8b127be..4193cc8 100644 --- a/README +++ b/README @@ -1,10 +1,22 @@ +README +====== + +Pithos is a file storage service, built by GRNET using Django (https://www.djangoproject.com/). +Learn more about Pithos at: http://code.grnet.gr/projects/pithos +Consult LICENSE for licensing information. + Documentation ------------- -To build the documentation you need to have Sphinx installed: -http://sphinx.pocoo.org/ +All docs are in the docs/source directory. The .rst files are perfectly readable in source form. + +To build the documentation you need to have Sphinx (http://sphinx.pocoo.org/) installed. -Run: +On a typical debian-based Linux system run: + apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2 + apt-get install python-sqlalchemy python-mysqldb python-psycopg2 + +Then run: python setup.py build_sphinx The documentation will be built in the docs/build/html directory. @@ -17,11 +29,18 @@ Then find the plain text version of the docs in docs/build/text. Running the server ------------------ -Enter the pithos dir, copy settings.py.dist to settings.py and change the SECRET_KEY inside. +Make sure you have all required packages installed: + apt-get install python-django python-setuptools python-sphinx python-httplib2 + apt-get install python-sqlalchemy python-mysqldb python-psycopg2 Then run: python manage.py syncdb - python manage.py loaddata aai/fixtures/auth_test_data.json (to load sample users) + python manage.py schemamigration im --initial + 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.