Skip to content

Commit

Permalink
Collect upgrading info at one palce
Browse files Browse the repository at this point in the history
  • Loading branch information
fsbraun committed Nov 19, 2024
1 parent d0a5497 commit 4993957
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 20 deletions.
20 changes: 0 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,26 +49,6 @@ Documentation
Please head over to the separate `documentation <https://django-filer.readthedocs.io/en/latest/index.html>`_
for all the details on how to install, configure and use django-filer.

Upgrading
=========

Version 3.3
-----------

django-filer version 3 contains a change in security policy for file uploads.
**By default, binary file or files of unknown type are not allowed to be uploaded.**
To allow upload of binary files in your project, add

.. code-block:: python
FILER_REMOVE_FILE_VALIDATORS = [
"application/octet-stream",
]
to your project's settings. Be aware that binary files always are a security risk.
See the documentation for more information on how to configure file upload validators,
e.g., running files through a virus checker.


.. |pypi| image:: https://badge.fury.io/py/django-filer.svg
:target: http://badge.fury.io/py/django-filer
Expand Down
19 changes: 19 additions & 0 deletions docs/upgrading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,25 @@ Usually upgrade procedure is straightforward: update the package and run migrati
require special attention from the developer and here we provide upgrade instructions for such cases.


from 3.x to 3.3
---------------

django-filer version 3.3 contains a change in security policy for file uploads.
**By default, binary file or files of unknown type are not allowed to be uploaded.**
To allow upload of binary files in your project, add

.. code-block:: python
FILER_REMOVE_FILE_VALIDATORS = [
"application/octet-stream",
]
to your project's settings. Be aware that binary files always are a security risk.
See :ref:`check_virus` for more information on how to configure file upload validators,
e.g., running files through a virus checker.



from 2.x to 3.0
---------------

Expand Down
2 changes: 2 additions & 0 deletions docs/validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,8 @@ If you distinguish validation by the mime type, remember to register the
validator function for all relevant mime types.


.. _check_virus:

Checking uploads for viruses using ClamAV
-----------------------------------------

Expand Down

0 comments on commit 4993957

Please sign in to comment.