django CMS File

June 23, 2026 · View on GitHub

=============== django CMS File

django CMS File is a set of plugins for django CMS <http://django-cms.org>_ that allow you to add files to your site You can either choose a single file or an entire folder.

It uses files managed by Django Filer <https://github.com/divio/django-filer>_.

This addon is compatible with Divio Cloud <http://divio.com>_ for easy installation.

.. image:: preview.gif

Contributing

This is a an open-source project. We'll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines <http://docs.django-cms.org/en/latest/contributing/index.html>_.

We're grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors <https://github.com/divio/djangocms-file/graphs/contributors>_ section.

One of the easiest contributions you can make is helping to translate this addon on Transifex <https://www.transifex.com/projects/p/djangocms-file/>_.

Documentation

See dependencies in the pyproject.toml <https://github.com/django-cms/djangocms-file/blob/master/pyproject.toml>_ file for additional dependencies:

Django Filer 2 or higher

Make sure django-filer <http://django-filer.readthedocs.io/en/latest/installation.html>_ is installed and configured appropriately.

Installation

For a manual install:

run pip install djangocms-file
add djangocms_file to your INSTALLED_APPS
run python manage.py migrate djangocms_file

Configuration

Note that the provided templates are very minimal by design. You are encouraged to adapt and override them to your project's requirements.

This addon provides a default template for all instances. You can provide additional template choices by adding a DJANGOCMS_FILE_TEMPLATES setting::

DJANGOCMS_FILE_TEMPLATES = [
    ('feature', _('Featured Version')),
]

You'll need to create the feature folder inside templates/djangocms_file/ otherwise you will get a template does not exist error. You can do this by copying the default folder inside that directory and renaming it to feature.

Running Tests

You can run tests by executing::

virtualenv env
source env/bin/activate
pip install -U pip tox
tox

.. |pypi| image:: https://badge.fury.io/py/djangocms-file.svg :target: http://badge.fury.io/py/djangocms-file .. |build| image:: https://github.com/django-cms/djangocms-file/actions/workflows/codecov.yml/badge.svg :target: https://github.com/django-cms/djangocms-file/actions/workflows/codecov.yml .. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-file/branch/master/graph/badge.svg :target: https://codecov.io/gh/django-cms/djangocms-file

.. |python| image:: https://img.shields.io/pypi/pyversions/djangocms-file :target: https://pypi.org/project/djangocms-file/ .. |django| image:: https://img.shields.io/pypi/frameworkversions/django/djangocms-file :target: https://www.djangoproject.com/ .. |djangocms| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-file :target: https://www.django-cms.org/