Synnefo

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 COPYRIGHT for licensing information.

About Pithos application

------------------------

This package contains the Django application that implements the Pithos v2 API. It depends on the Pithos backend, which does the actual data and metadata operations.

How to run

----------

Use snf-webproject to run Pithos automatically.

To use Pithos in a custom Django project, just add ``pithos.api`` to ``INSTALLED_APPS``.

Pithos has been tested with SQLite and PostgreSQL backend databases. When using PostgreSQL, ensure that the has been created with the appropriate encoding and collation::

    CREATE DATABASE pithos WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0;

Settings

--------

Configure in ``settings.py`` or a ``.conf`` file in ``/etc/synnefo`` if using snf-webproject.

===============================  ================================================================   ============================================================

Name                             Default value                                                      Description

===============================  ================================================================   ============================================================

ASTAKOS_URL                      \https://<astakos.host>/                                           Astakos Authentication URL

PITHOS_ASTAKOS_COOKIE_NAME       _pithos2_a                                                         Cookie name to retrieve fallback token

PITHOS_BACKEND_DB_MODULE         pithos.backends.lib.sqlalchemy

PITHOS_BACKEND_DB_CONNECTION     sqlite:////tmp/pithos-backend.db                                   SQLAlchemy database connection string

PITHOS_BACKEND_BLOCK_MODULE      pithos.backends.lib.hashfile

PITHOS_BACKEND_BLOCK_PATH        /tmp/pithos-data/                                                  Map and block storage path

PITHOS_BACKEND_BLOCK_UMASK       0o022                                                              Map and block storage umask

PITHOS_BACKEND_QUEUE_MODULE      None                                                               Use ``pithos.backends.lib.rabbitmq`` to enable

PITHOS_BACKEND_QUEUE_HOSTS       None                                                               Format like [``amqp://guest:guest@localhost:5672``

PITHOS_BACKEND_QUEUE_EXCHANGE    pithos

PITHOS_BACKEND_ACCOUNT_QUOTA     50 GB (50 * 1024 ** 3)                                             Default account quota (set to 0 to disable control)

PITHOS_BACKEND_CONTAINER_QUOTA   0                                                                  Default container quota (set to 0 to disable control - default disabled)

PITHOS_BACKEND_VERSIONING        auto                                                               Default versioning policy for containers

PITHOS_BACKEND_FREE_VERSIONING   True                                                               Default versioning debit policy (default free)

PITHOS_BACKEND_POOL_SIZE         5                                                                  Default backend pool size

PITHOS_UPDATE_MD5                False                                                               Update object checksums

PITHOS_SERVICE_TOKEN             ''                                                                 Service token acquired by the identity provider (astakos)

PITHOS_RADOS_STORAGE             False                                                              Enables or disables secondary Pithos storage on RADOS

PITHOS_RADOS_POOL_BLOCKS         None                                                               RADOS pool to be used for block storage

PITHOS_RADOS_POOL_MAPS           None                                                               RADOS pool to be used for maps storage

PITHOS_TRANSLATE_UUIDS           False                                                              Enables a ui compatibility layer for the introduction of UUIDs in identity management.

PITHOS_PROXY_USER_SERVICES       True                                                               Whether to proxy user feedback and catalog services

PITHOS_USER_CATALOG_URL          \https://<astakos.host>/user_catalogs/                             Astakos User Catalog URL

PITHOS_USER_FEEDBACK_URL         \https://<astakos.host>/feedback/                                  Astakos User Feedback URL

PITHOS_USER_LOGIN_URL            \https://<astakos.host>/login/                                     Astakos User Login URL

PITHOS_USE_QUOTAHOLDER           True                                                               Enable quotaholder

PITHOS_QUOTAHOLDER_URL           ''                                                                 Quotaholder URL

PITHOS_QUOTAHOLDER_TOKEN         ''                                                                 Quotaholder token

PITHOS_PUBLIC_URL_SECURITY       16                                                                 How many random bytes to use for constructing the URL of Pithos public files

PITHOS_PUBLIC_URL_ALPHABET       '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'   The alphabet to use for constructing the URL of Pithos public files

===============================  ================================================================   ============================================================

To update checksums asynchronously, enable the queue, install snf-pithos-tools and use ``pithos-dispatcher``::

    pithos-dispatcher --exchange=pithos --key=pithos.object --callback=pithos.api.dispatch.update_md5

To send sharing notifications::

    pithos-dispatcher --exchange=pithos --key=pithos.sharing --callback=pithos.api.dispatch.send_sharing_notification

Administrator functions

-----------------------

Available as extensions to Django's command-line management utility:

============  ======================

Name          Description

============  ======================

storagequota  Get/set a user's quota

============  ======================