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.

Sign up for GitHub

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

Clean up deprecated behaviors from the S3BotoStorage #636

Merged
merged 1 commit into from
Jun 7, 2020
+51 −332
Merged

Clean up deprecated behaviors from the S3BotoStorage #636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,31 @@ django-storages CHANGELOG
UNRELEASED
**********

**Breaking**

- Removed support for end-of-life Python 2.7 and 3.4.

- The minimum supported version of boto3 is now 1.4.4.

- The ``S3Boto3Storage`` backend no longer accepts the argument ``acl``. Use
the ``ACL`` key in ``AWS_S3_OBJECT_PARAMETERS`` instead.

- The ``S3Boto3Storage`` backend no longer accepts the argument ``bucket``. Use
``bucket_name`` or the setting ``AWS_STORAGE_BUCKET_NAME`` instead.

- The ``S3Boto3Storage`` backend no longer automatically creates the bucket.
Doing so had encouraged using overly broad credentials. As a result, the
``AWS_BUCKET_ACL`` setting has been removed.

- The ``S3Boto3Storage`` backend no longer not longer supports the settings
``AWS_DEFAULT_ACL``, ``AWS_REDUCED_REDUNDANCY`` and ``AWS_S3_ENCRYPTION``.
They have been removed in favor of the ``AWS_S3_OBJECT_PARAMETERS`` setting.
Using ``AWS_S3_OBJECT_PARAMETERS`` allows for full control over these S3
parameters.

- The ``S3Boto3Storage`` backend no longer supports the undocumented
``AWS_PRELOAD_METADATA`` setting.

1.9.1 (2020-02-03)
******************

Expand Down
47 changes: 5 additions & 42 deletions docs/backends/amazon-S3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ There is only one supported backend for interacting with Amazon's S3,
The legacy ``S3BotoStorage`` backend was removed in version 1.9. To continue getting new features you must upgrade
to the ``S3Boto3Storage`` backend by following the :ref:`migration instructions <migrating-boto-to-boto3>`.

The minimum required version of ``boto3`` is 1.4.4 although we always recommend
the most recent.

Settings
--------

Expand All @@ -34,37 +37,6 @@ To allow ``django-admin.py`` collectstatic to automatically put your static file
``AWS_STORAGE_BUCKET_NAME``
Your Amazon Web Services storage bucket name, as a string.

``AWS_DEFAULT_ACL`` (optional, ``None`` or canned ACL, default ``public-read``)
Must be either ``None`` or from the `list of canned ACLs`_. If set to ``None``
then all files will inherit the bucket's ACL.

.. warning::

The default value of ``public-read`` is insecure and will be changing to ``None`` in
a future release of django-storages. Please set this explicitly to ``public-read``
if that is the desired behavior.

``AWS_BUCKET_ACL`` (optional, default ``public-read``)
Only used if ``AWS_AUTO_CREATE_BUCKET=True``. The ACL of the created bucket.

Must be either ``None`` or from the `list of canned ACLs`_. If set to ``None``
then the bucket will use the AWS account's default.

.. warning::

The default value of ``public-read`` is insecure and will be changing to ``None`` in
a future release of django-storages. Please set this explicitly to ``public-read``
if that is the desired behavior.

``AWS_AUTO_CREATE_BUCKET`` (optional)
If set to ``True`` the bucket specified in ``AWS_STORAGE_BUCKET_NAME`` is automatically created.

.. deprecated:: 1.9

The ability to automatically create a bucket will be removed in version 1.10. The permissions needed
to do so are incongruent with the requirements of the rest of this library. Either create it yourself
or use one of the popular configuration management tools.

``AWS_S3_OBJECT_PARAMETERS`` (optional, default ``{}``)
Use this to set parameters on all objects. To set these on a per-object
basis, subclass the backend and override ``S3Boto3Storage.get_object_parameters``.
Expand All @@ -84,14 +56,6 @@ To allow ``django-admin.py`` collectstatic to automatically put your static file
``AWS_QUERYSTRING_EXPIRE`` (optional; default is 3600 seconds)
The number of seconds that a generated URL is valid for.

``AWS_S3_ENCRYPTION`` (optional; default is ``False``)
Enable server-side file encryption while at rest.

.. deprecated:: 1.9

Support for this top level setting is deprecated. The functionality is still available by setting
ServerSideEncryption=AES256 in AWS_S3_OBJECT_PARAMETERS.

``AWS_S3_FILE_OVERWRITE`` (optional: default is ``True``)
By default files with the same name will overwrite each other. Set this to ``False`` to have extra characters appended.

Expand Down Expand Up @@ -170,9 +134,8 @@ The following adjustments to settings are required:
- If you persist urls and rely on the output to use the signature version of ``s3`` set ``AWS_S3_SIGNATURE_VERSION`` to ``s3``
- Update ``DEFAULT_FILE_STORAGE`` and/or ``STATICFILES_STORAGE`` to ``storages.backends.s3boto3.S3Boto3Storage``

Additionally, you must install ``boto3``. In order to use
all currently supported features, ``1.4.4`` is the minimum required version although we
always recommend the most recent.
Additionally, you must install ``boto3``. The minimum required version is 1.4.4
although we always recommend the most recent.

Please open an issue on the GitHub repo if any further issues are encountered or steps were omitted.

Expand Down
Loading