Uninstalling Keel
Uninstalling never happens by itself: nothing in Keel, no update and no cache clear removes what Keel stored. Steps 1 to 5 remove Keel and what it stored; your content (data objects, pages, assets) stays as it is.
Back up first
Back up the database and your config folder before you start. Step 2 cannot be undone.
1. Keep what you still need
- Scripts on the website. Keel adds the code from Setup → Settings → Scripts & tracking, and each page's own scripts, to the website's pages. Once Keel is gone these stop at once: analytics, tag manager, consent, chat. Copy them to your templates first.
- Project code that uses Keel: classes that use
Keel\Bundle\…, such as overview cards (DashboardWidgetInterface),ObjectUrlProviderInterface,ObjectImageProviderInterfaceor subclasses of Keel's controllers. Remove them, or the container will not compile. See Extending Keel.
2. Remove what Keel stored
While the bundle is still enabled, run
bin/console pimcore:bundle:uninstall KeelBundle
It removes:
| What | Where |
|---|---|
Keel's eight tables: keel_bulk_job, keel_bulk_item (bulk jobs), keel_completeness_rule, keel_completeness (completeness), keel_follow (following), keel_import_stage (import previews), keel_history, keel_history_item (Setup → History) | Keel's own tables |
| Files of export jobs | Pimcore's temp storage, folder keel-jobs/ |
Sort indexes keel_s_* | the classes' object_query_* and object_localized_query_* tables (also bin/console keel:sort-indexes --drop) |
Customize, Data model field tweaks, Scripts & tracking (keel), old History rows (keel_history), Keel page check and Site check results (keel_pagecheck), each user's My view (keel_user) | settings_store, those four scopes |
keel_assignee (objects), keel_head_scripts, keel_body_scripts (pages), keel_rights_until, keel_rights_note (assets) | properties |
Then it clears Pimcore's cache. It keeps:
-
Notes of types
keel-assign,keel-status,keel-note(the Activity log and internal notes; Pimcore shows them in an item's Notes & Events tab). They are part of the items' history; delete them by type if you want them gone:DELETE nd FROM notes_data nd JOIN notes n ON n.id = nd.id WHERE n.type IN ('keel-assign', 'keel-status', 'keel-note'); DELETE FROM notes WHERE type IN ('keel-assign', 'keel-status', 'keel-note'); -
Role layouts
keel_role_*made in Field access: Pimcore custom layouts, named in the roles' workspaces. Remove them in Field access first (while Keel is still there), or in Pimcore's class editor.
3. Remove the configuration
-
Remove this line from
config/bundles.php:Keel\Bundle\KeelBundle::class => ['all' => true], -
Delete
config/routes/keel.yaml. -
Delete
config/packages/keel.yaml. -
Remove
KEEL_LICENSE_KEYfrom.env.localor the server's variables.
Do this before step 4: composer remove normally clears the cache, and that fails while the project still names the bundle.
4. Remove the bundle
composer remove keel/pimcore-keel
5. Clear what is left
bin/console assets:install public # removes public/bundles/keel
bin/console cache:clear
Reload the admin. The Keel tab is gone.
ZIP downloads that were still waiting may be left in the keel-zip folder of Pimcore's temp folder (var/tmp). You can delete that folder.
What stays
- Files uploaded in the editor stay in the asset folder
/dashboard-uploads(or yourupload_folder). They are ordinary assets. - Versions saved through Keel, and their version notes such as Keel: reverted (History), stay in Pimcore.
- Notifications about assignments stay in the users' Pimcore notifications.