Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added instructions to use S3 backend with Backblaze B2 #1105

Merged
merged 1 commit into from
Dec 18, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/backends/backblaze-B2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Backblaze B2
============

Backblaze B2 implements an `S3 Compatible API <https://www.backblaze.com/b2/docs/s3_compatible_api.html>`_. To use it as a django-storages backend:

#. Sign up for a `Backblaze B2 account <https://www.backblaze.com/b2/sign-up.html?referrer=nopref>`_, if you have not already done so.
#. Create a public or private bucket. Note that object-level ACLs are not supported by B2 - all objects inherit their bucket's ACLs.
#. Create an `application key <https://www.backblaze.com/b2/docs/application_keys.html>`_. Best practice is to limit access to the bucket you just created.
#. Follow the instructions in the :doc:`Amazon S3 docs <amazon-S3>` with the following exceptions:

* Set ``AWS_S3_REGION_NAME`` to your Backblaze B2 region, for example, ``us-west-004``
* Set ``AWS_S3_ENDPOINT_URL`` to ``https://s3.${AWS_S3_REGION_NAME}.backblazeb2.com``
* Set the values of ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY`` to the application key id and application key you created in step 2.