Using the TinyMCE .zip package with the Django framework

This Integration is maintained by a third-party developer. Tiny Technologies, Inc. bears no responsibility for this integration, which is not covered by the Tiny Self-Hosted Software License Agreement. For issues related to the integration, contact the third-party project directly.

For information on adding TinyMCE to a Django project, try using the Python-based django-tinymce package. For information on setting up django-tinymce, see: the django-tinymce Documentation.

To download TinyMCE and use it with the django-tinymce package:

  1. Get the package from TinyMCE Downloads.

  2. Unzip the package and move the 'path/to/tinymce/' directory into the django project.

  3. Add a URL path to the tinymce directory.

  4. Add the relevant configuration setting:

    • If you do not need the TINYMCE_COMPRESSOR (TINYMCE_COMPRESSOR = False), add TINYMCE_JS_URL to the project’s settings.py file pointing to tinymce/tinymce.min.js. Such as:

      TINYMCE_JS_URL = os.path.join(MEDIA_URL, "path/to/tinymce/tinymce.min.js")
      TINYMCE_COMPRESSOR = False
    • If you do need the TINYMCE_COMPRESSOR (TINYMCE_COMPRESSOR = TRUE), add TINYMCE_JS_ROOT to the project’s settings.py file pointing to the tinymce/ root directory. Such as:

      TINYMCE_JS_ROOT = os.path.join(MEDIA_URL, "path/to/tinymce")
      TINYMCE_COMPRESSOR = True
  5. Set license_key in TINYMCE_DEFAULT_CONFIG in the project’s settings.py file. TINYMCE_DEFAULT_CONFIG replaces the default django-tinymce configuration, so include any other options the editor needs. Such as:

    TINYMCE_DEFAULT_CONFIG = {
        "license_key": "gpl",
        "height": 500,
        "menubar": False,
        "browser_spellcheck": True,
        "plugins": "advlist,autolink,lists,link,image,charmap,preview,anchor,"
        "searchreplace,visualblocks,code,fullscreen,insertdatetime,media,table,"
        "help,wordcount",
        "toolbar": "undo redo | blocks | bold italic backcolor | alignleft aligncenter "
        "alignright alignjustify | bullist numlist outdent indent | removeformat | help",
    }
    The gpl license key is for self-hosting TinyMCE under the GNU General Public License (GPL). To use a commercial license, or to include premium plugins, replace gpl with a valid license key. For details, see Setting the license.