================================= django-ckeditor-filebrowser-filer

|Gitter| |PyPiVersion| |PyVersion| |License|

A django-filer based CKEditor filebrowser

Supported versions

Python: 3.7 to 3.11

Django: 3.2 to 4.2

django-filer: 2.0 and above

Documentation

Original code is taken from django-ckeditor-filer_

It supports both ckeditor widget provided by django-ckeditor and the one provided by djangocms-text-ckeditor.

.. warning:: if you are using filer<1.2 this plugin requires django CMS_ cmsplugin_filer_image_, thus you need to install and configure both according to their respective documentation.

Quickstart

• Install django-ckeditor-filebrowser-filer::

  pip install django-ckeditor-filebrowser-filer

• Add it to INSTALLED_APPS along with its dependencies::

  'filer', 'ckeditor_filebrowser_filer',

• Configure django-filer Canonical URLs_

• Add ckeditor_filebrowser_filer to urlconf::

  url(r'^filebrowser_filer/', include('ckeditor_filebrowser_filer.urls')),

  Currently only filebrowser_filer/ is supported as url path

• Add FilerImage button to you CKEditor configuration:

  • Add 'FilerImage' to a toolbar in CKEDITOR_CONFIGS
  • Add 'filerimage' in 'extraPlugins' in CKEDITOR_CONFIGS
  • Add 'image' in 'removePlugins' in CKEDITOR_CONFIGS

Example::

CKEDITOR_CONFIGS = {
    'default': {
        'toolbar': 'Custom',
        'toolbar_Custom': [
            ...
            ['FilerImage']
        ],
        'extraPlugins': 'filerimage',
        'removePlugins': 'image'
    },
}

when using djangocms-text-ckeditor_ use CKEDITOR_SETTINGS instead of CKEDITOR_CONFIGS.

.. _Canonical URLs: https://django-filer.readthedocs.io/en/latest/installation.html#canonical-urls .. _django CMS: https://pypi.python.org/pypi/django-cms .. _django-filer: https://pypi.python.org/pypi/django-filer .. _cmsplugin_filer_image: https://pypi.python.org/pypi/cmsplugin_filer_image .. _django-ckeditor: https://pypi.python.org/pypi/django-ckeditor .. _djangocms-text-ckeditor: https://pypi.python.org/pypi/djangocms-text-ckeditor .. _django-ckeditor-filer: https://github.com/ikresoft/django-ckeditor-filer/

.. |Gitter| image:: https://img.shields.io/badge/GITTER-join%20chat-brightgreen.svg?style=flat-square :target: https://gitter.im/nephila/applications :alt: Join the Gitter chat

.. |PyPiVersion| image:: https://img.shields.io/pypi/v/django-ckeditor-filebrowser-filer.svg?style=flat-square :target: https://pypi.python.org/pypi/django-ckeditor-filebrowser-filer :alt: Latest PyPI version

.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/django-ckeditor-filebrowser-filer.svg?style=flat-square :target: https://pypi.python.org/pypi/django-ckeditor-filebrowser-filer :alt: Python versions

.. |Status| image:: https://img.shields.io/travis/nephila/django-ckeditor-filebrowser-filer.svg?style=flat-square :target: https://travis-ci.org/nephila/django-ckeditor-filebrowser-filer :alt: Latest Travis CI build status

.. |TestCoverage| image:: https://img.shields.io/coveralls/nephila/django-ckeditor-filebrowser-filer/master.svg?style=flat-square :target: https://coveralls.io/r/nephila/django-ckeditor-filebrowser-filer?branch=master :alt: Test coverage

.. |License| image:: https://img.shields.io/github/license/nephila/django-ckeditor-filebrowser-filer.svg?style=flat-square :target: https://pypi.python.org/pypi/django-ckeditor-filebrowser-filer/ :alt: License

.. |CodeClimate| image:: https://codeclimate.com/github/nephila/django-ckeditor-filebrowser-filer/badges/gpa.svg?style=flat-square :target: https://codeclimate.com/github/nephila/django-ckeditor-filebrowser-filer :alt: Code Climate