cleanup pithos backend pools, new pool api support

[pithos] / snf-pithos-app / README

diff --git a/snf-pithos-app/README b/snf-pithos-app/README
index c8a1513..7a674b1 100644 (file)
--- a/snf-pithos-app/README
+++ b/snf-pithos-app/README
@@ -18,6 +18,10 @@ 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
 --------
 
@@ -32,12 +36,23 @@ 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.hashfiler
 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_CONNECTION  None                                              Format like ``rabbitmq://guest:guest@localhost:5672/pithos``
 PITHOS_BACKEND_QUOTA             50 GB (50 * 1024 ** 3)                            Default user quota
 PITHOS_BACKEND_VERSIONING        auto                                              Default versioning policy for containers
+PITHOS_UPDATE_MD5                True                                              Update object checksums when using hashmaps
+PITHOS_SERVICE_TOKEN             ''                                                Service token acquired by the identity provider (astakos)
 ===============================  ================================================  ============================================================
 
+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
 -----------------------