README.rst

django-ckeditor-filebrowser-filer

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.