Statistics
| Branch: | Tag: | Revision:

root / snf-pithos-app / README @ dfb1fafa

History | View | Annotate | Download (2.6 kB)

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

    
7
Consult COPYRIGHT for licensing information.
8

    
9
About Pithos application
10
------------------------
11

    
12
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.
13

    
14
How to run
15
----------
16

    
17
Use snf-webproject to run Pithos automatically.
18

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

    
21
Settings
22
--------
23

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

    
26
===============================  ================================================  ============================================================
27
Name                             Default value                                     Description
28
===============================  ================================================  ============================================================
29
PITHOS_AUTHENTICATION_URL        \http://127.0.0.1:8000/im/authenticate            Astakos API URL
30
PITHOS_AUTHENTICATION_USERS      A dictionary of sample users (token to username)  Set to empty or None to disable
31
PITHOS_BACKEND_DB_MODULE         pithos.backends.lib.sqlalchemy
32
PITHOS_BACKEND_DB_CONNECTION     sqlite:////tmp/pithos-backend.db                  SQLAlchemy database connection string
33
PITHOS_BACKEND_BLOCK_MODULE      pithos.backends.lib.hashfiler
34
PITHOS_BACKEND_BLOCK_PATH        /tmp/pithos-data/                                 Map and block storage path
35
PITHOS_BACKEND_QUEUE_MODULE      None                                              Use ``pithos.backends.lib.rabbitmq`` to enable
36
PITHOS_BACKEND_QUEUE_CONNECTION  None                                              Format like ``rabbitmq://guest:guest@localhost:5672/pithos``
37
PITHOS_BACKEND_QUOTA             50 GB (50 * 1024 ** 3)                            Default user quota
38
PITHOS_BACKEND_VERSIONING        auto                                              Default versioning policy for containers
39
===============================  ================================================  ============================================================
40

    
41
Administrator functions
42
-----------------------
43

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

    
46
============  ======================
47
Name          Description
48
============  ======================
49
storagequota  Get/set a user's quota
50
============  ======================
51

    
52