Skip to content
Docs

User guide

Updates

This explains how to update Zittme to a new version.

Before you start

  • Back up first. Back up the files/ folder and the database. All of your site's settings, attachments, and data are in these two.
  • When the admin dashboard shows a new version notice, you can download the distribution from the release page.

Updating with the archive (default)

  1. Download the new distribution from the release page.
  2. Extract it and copy it right over your existing installation.
  3. Open the admin screen. If any DB changes are needed, you are notified and they are applied automatically.
  4. Why this method is safe:

    • All settings and attachments are stored in the files/ folder and the DB, and the distribution does not include a files/ folder. Overwriting does not erase your data.
    • Third-party modules, add-ons, and skins live in paths not included in the distribution, so they are preserved.
    Caution: If you had edited core files (files included in the distribution) directly, all of those edits are lost the moment you overwrite them. Instead of editing the core, we recommend implementing the behavior you want with skins, layouts, or addons.

    After updating

    • Admin access: if a notice to apply DB changes appears, run it
    • If the screen looks wrong, run Regenerate cache files in the admin or empty the contents of files/cache

    If something goes wrong

    • If you get a blank white screen, empty files/cache and refresh.
    • If that does not help, roll back to the previous version's files from your backup, then describe the symptoms in the community. If there is a PHP error message, include it too.

    Updating with Git

    Updating via git from the public Zittme repository is in preparation. It will be explained in this document once available.