Skip to content
Docs

User guide

Moving from Rhymix or XE

This page covers what you need to know when moving a site that ran on Rhymix or XE to Zittme.

From Rhymix to Zittme

Zittme was forked from Rhymix 2.1.35 and stays compatible with it.

  • Most third-party modules, add-ons, skins, and layouts work as is. The core Rhymix\ namespace remains as a compatibility alias.
  • The migration process is the same as an update: back up, overwrite with the Zittme release, and open the admin screen.
  • The DB structure is compatible with Rhymix 2.1.35. Tables for Zittme-specific features are added automatically when you access the admin screen.

Things to watch for:

  • If you had modified Rhymix core files directly, those changes are lost when you overwrite.
  • After the migration, zittEditor is suggested as the default editor. If you had explicitly chosen ckeditor, that choice is kept.
  • Going back (Zittme → Rhymix) means accepting that data from Zittme-specific features (themes, repeat fields, and so on) will be ignored, and it is not recommended. Always keep a backup from before the migration.

From XE 1.x to Zittme

After upgrading, you cannot go back to XE. The only way to recover is a backup made beforehand.

Prerequisites

  • You need XE 1.8 or later to upgrade directly. If you are on an older version, first upgrade to the latest XE (1.11), finish all module updates and table creation, and then proceed.
  • Make sure the server runs PHP 7.4 or later (XE ran on 5.x, but Zittme does not).
  • Back up your FTP files and DB in a form you can restore yourself.
  • Start the work while logged in as the top administrator.

Steps

  1. Download the Zittme release and overwrite everything in the XE installation folder. Confirm a 100% upload so new folders (such as common/framework) are not missed. FTP sometimes drops a few of thousands of files.
  2. Refresh the admin screen and prompts for module updates and table creation appear. Run all of them.
  3. Run cache file regeneration. If it fails, you can delete the contents of files/cache via FTP.
  4. Review the site and security settings in System settings.
  5. Review the third-party checklist below, and turn features that were absorbed into the core back on in their new locations.
  6. Use the unneeded core file cleanup on the admin dashboard to remove leftover XE files.
  7. Large sites take time to convert. Always practice on a copy server first; separate migration tools are not recommended.

    XE third-party resource checklist

    Many resources from the XE era have either been absorbed into the core or no longer work.

    ResourceStatusAction
    Advanced mail modulePartially absorbedRecheck the mail sending method in System settings > Notification settings
    Auto login moduleFully absorbedUse the core feature. Existing auto logins are reset
    Multidomain moduleFully absorbedSystem settings > Site settings
    SEO moduleMovedSystem settings > SEO settings
    Error log moduleMovedSystem settings > Debug settings
    Session shield add-onMovedSession security key in System settings > Advanced settings
    Script compression (ZipperUpper)MovedSystem settings > Advanced settings
    Communication add-onNot neededMessaging is in the core communication module
    CAPTCHA add-onDoes not workReplace with reCAPTCHA
    External jQuery loader add-onsNot supportedRemove
    CafeXE / Homepage moduleNot supportedConflicts with multidomain. Upgrading is not recommended

    Criteria: Fully absorbed (integrated into the core, configure in the new location) / Partially absorbed (only partly integrated) / Moved (moved to a different menu) / Not supported (replacement needed) / Does not work (replace immediately).

    Migration steps at a glance

    1. Back up the live site's files/ and DB
    2. Practice the migration on a copy server first
    3. Sort out resources that appear in the checklist above
    4. Replace the files with the Zittme release, open the admin screen, and run the DB conversion
    5. Check pages, login, posting, and attachments