This documentation is deprecated/obsolete. Lute v2 has been replaced by Lute v3, a full Python rewrite. Please see the Lute v3 manual which includes notes on installation. If you have Lute v2, you can easily migrate to v3. Thank you!

Lute is periodically updated with improvements and fixes, and new releases are announced in the "announcements" channel of the Lute Discord.

To update, get the new Lute release, copy your personal data to a brand new installation folder, rebuild your image if you're using Docker, and then start the new installation.

If you're using Lute v1, which uses MySQL, see Migration from v1 to v2.

1. Backup your existing Lute database. On the Lute Home screen, click "Create backup."

2. Stop your current Lute instance, if it's running.

3. Rename your current lute_release folder to lute_release_old

4. Get the latest GitHub release, and put it in the same folder as your lute_release_old folder.

It should look like this:

- <parent_folder>/
  lute_release_old/
     ... stuff
  lute_release.zip

5. Unzip lute_release.zip to a new lute_release directory

- <parent_folder>/
  lute_release_old/
     ...
  lute_release.zip
  lute_release/
     ...

6. COPY your personal files and folders from lute_release_old to lute_release, replacing the existing stuff:

• files: .env
• folder: data (containing the database and userimages)

Note: I suggest you copy, rather than just move files, because Lute upgrades often come with database schema updates. In step 1, you already made a backup of your DB, but keeping your old Lute around until you've verified everything in the new setup means that it's easy to go back. (ps - I test and use Lute's features extensively before I release an upgrade -- I'm not a total code cowboy -- so I'm confident things will work on release. That said, it's your data!)

7. (Docker only) Rebuild your Lute image.

You might need to stop your current Lute, if it's running. Then build the new Lute image. In your new lute_release folder, run docker compose build to update your image.

After that, you should check that your image has updated: run docker image ls and check the age of the image! It should say something like "lute_release-lute latest 057ccdd61acd About a minute ago 1.15GB"

Some users have had problems with images not updating on build. You can forcefully remove everything from your system and rebuild from scratch using:

# Stop all running containers
docker stop $(docker ps -a -q)

# Delete all containers
docker rm $(docker ps -a -q)

# Remove all images
docker rmi $(docker images -q)

Then docker compose build should build everything from scratch.

8. Start your new installation, and verify that everything is OK!

9. Delete lute_release_old

If you set up Lute via git clone, pull the changes as usual (pull, fetch and merge, however you usually do it).

If you upgrade in-place, you might need to clear the application cache. Lute uses a framework called Symfony which caches code, and a git pull or whatever won't touch the cache. In a Terminal window in your Lute root folder, run the following:

php composer.phar dev:nukecache