Skip to content

Installation

Basic installation and configuration

Install django-tinymce4-plus from PyPI:

pip install django-tinymce4-plus

uv add django-tinymce4-plus

poetry add django-tinymce4-plus

Add tinymce to INSTALLED_APPS in settings.py for your Django project:

INSTALLED_APPS = (
    ...
    'tinymce',
)

Add tinymce.urls to urls.py for your project:

urlpatterns = [
    ...
    path('tinymce/', include('tinymce.urls')),
    ...
]

Or with old-style regex url:

urlpatterns = [
    ...
    url(r'^tinymce/', include('tinymce.urls')),
    ...
]

Plugins

If you want to use django-filebrowser-no-grappelli file manager, install this package. Refer to django-filebrowser documentation to learn how to install and configure the filebrowser application.

For TinyMCE spellchecker plugin, you need to install the pyenchant extra package:

pip install django-tinymce4-plus[enchant]

uv add django-tinymce4-plus[enchant]

poetry add django-tinymce4-plus[enchant]

or just

pip install pyenchant

uv add pyenchant

poetry add pyenchant

On some Linux systems, you may also need to install binary enchant libraries prior to installing pyenchant. For example, on Debian/Ubuntu use the following command:

sudo apt-get install enchant

Also, you need to add the necessary spelling dictionaries if they are missing from pyenchant default installation on your system.

Read the Language Configuration subsection about configuring the tinymce4-plus spellchecker.

Upgrade

It is strongly recommended to upgrade tinymce4-plus by specifying the exact application version you want to upgrade to:

pip install django-tinymce4-plus==X.Y.Z

uv add django-tinymce4-plus==X.Y.Z

poetry add django-tinymce4-plus==X.Y.Z

Unless you are loading TinyMCE 4 from a CDN, after upgrading you need to run Django's collectstatic command to update TinyMCE 4 static files in your folder where your project's static files are served from:

python3 manage.py collectstatic