Sign up (with export icon)

Maintaining your editor

Contribute to this guideShow the table of contents

Maintaining your editor means keeping CKEditor 5 and all its plugins on the same, up-to-date version so you get the latest fixes, features, and security patches. This guide covers the routine practices for doing so.

Daily maintenance

Copy link

Upgrade regularly

Copy link

CKEditor 5 should be updated frequently, as bug fixes and new features are not backported. While installing and using a CKEditor 5 instance, especially when adding new features, always make sure all the packages are of the same (preferably latest) version. If this requirement is not met, errors may occur.

Use Builder to add plugins

Copy link

Some releases would bring new features and new plugins and sometimes replace old ones and make them obsolete. If you want to install additional plugins, it is easier and safer to use the CKEditor 5 Builder instead of adding them manually. This will reduce the risk of omitting plugin dependencies.

Safety

Copy link

Observe any security alerts that are published by the CKEditor 5 team, especially the Security Advisories. Always act promptly to apply patches and upgrades as soon as these are released. Keeping your editor up-to-date is crucial to the security and integrity of you content and data. If you are using framework integrations, always follow any information provided by framework developers, too.

Data backup

Copy link

Whatever your approach toward updates might be, always remember to keep a fresh backup of your data. Whether a local solution is used, an on-premises server or the autosave feature, create regular backups of your database and files.