Metadata-Version: 2.0
Name: django-ipfs-storage
Version: 0.0.2
Summary: IPFS storage backend for Django.
Home-page: https://github.com/jeffbr13/django-ipfs-storage
Author: Ben Jeffrey
Author-email: mail@benjeffrey.net
License: MPL 2.0
Description-Content-Type: UNKNOWN
Keywords: django ipfs storage
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Framework :: Django
Requires-Dist: django
Requires-Dist: ipfsapi

django-ipfs-storage
===================

Store `Django
file-uploads <https://docs.djangoproject.com/en/1.11/topics/files/>`__
on the `Interplanetary File System <https://ipfs.io/>`__.

Uploads are added and pinned to the configured IPFS node, which returns
the IPFS Content ID (a hash of the contents). This hash is the name that
is saved to your database. Duplicate content will also have the same
address, saving disk space.

Because of this only file creation and reading is supported.

Other IPFS users access and reseed a piece of content through its unique
content ID. Differently-distributed (i.e. normal HTTP) users can access
the uploads through an HTTP→IPFS gateway.

Installation
------------

.. code:: bash

    pip install django-ipfs-storage

Configuration
-------------

By default ``ipfs_storage`` adds and pins content to an IPFS daemon
running on localhost and returns URLs pointing to the public
https://ipfs.io/ipfs/ HTTP Gateway

To customise this, set the following variables in your ``settings.py``:

-  ``IPFS_STORAGE_API_URL``: defaults to
   ``'http://localhost:5001/api/v0/'``.
-  ``IPFS_GATEWAY_API_URL``: defaults to ``'https://ipfs.io/ipfs/'``.

Set ``IPFS_GATEWAY_API_URL`` to ``'http://localhost:8080/ipfs/'`` to
serve content through your local daemon’s HTTP gateway.

Usage
-----

There are two ways to use a Django storage backend.

As default backend
~~~~~~~~~~~~~~~~~~

Use IPFS as `Django’s default file storage
backend <https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-DEFAULT_FILE_STORAGE>`__:

.. code:: python

    # settings.py

    DEFAULT_FILE_STORAGE = 'ipfs_storage.InterPlanetaryFileSystemStorage'

    IPFS_STORAGE_API_URL = 'http://localhost:5001/api/v0/'
    IPFS_STORAGE_GATEWAY_URL = 'http://localhost:8080/ipfs/'

For a specific FileField
~~~~~~~~~~~~~~~~~~~~~~~~

Alternatively, you may only want to use the IPFS storage backend for a
single field:

.. code:: python

    from django.db import models

    from ipfs_storage import InterPlanetaryFileSystemStorage 


    class MyModel(models.Model):
        # …
        file_stored_on_ipfs = models.FileField(storage=InterPlanetaryFileSystemStorage()) 
        other_file = models.FileField()  # will still use DEFAULT_FILE_STORAGE

Don’t forget the brackets to instantiate
``InterPlanetaryFileSystemStorage()`` with the default arguments!

FAQ
---

Why IPFS?
~~~~~~~~~

Not my department. See https://ipfs.io/#why.

How do I ensure my uploads are always available?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

I don’t know. Maybe look into using
`ipfs-cluster <https://github.com/ipfs/ipfs-cluster>`__ to spread it
across a few nodes? Or perhaps you could integrate
`Eternum <https://www.eternum.io>`__\ ’s hosted pinning service.

How do I backup my uploads?
~~~~~~~~~~~~~~~~~~~~~~~~~~~

See above.

How do I delete an upload?
~~~~~~~~~~~~~~~~~~~~~~~~~~

Because of the bittorrent-like nature of IPFS, anyone who accesses a
piece of content also has a copy, and rehosts it for you automatically
until it leaves their node’s local cache. Yay bandwidth costs! Boo
censorship!

Unfortunately, if you’re trying to censor yourself (often quite
necessary) this means the best we can do is unpin the piece of content
from your own IPFS node(s) and hope nobody else has pinned it. This is
``TODO``.

How do I securely expose my IPFS daemon’s API to connect remotely?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Someone please tell me.

How do I securely expose my own IPFS←HTTP Gateway?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Again, see above.


