Maintenance mode

Maintenance mode takes your server offline for everyone else while you do administrative work, such as restoring a database backup or replacing a library disk.

While it’s on:

• Everyone else sees the maintenance page instead of their library and is signed out.
• Administrators sign in on the maintenance page to end maintenance or restore a backup.
• Uploads, mobile backups and shared links pause until maintenance mode ends.

Frameleaf turns maintenance mode on by itself when you restore a database backup, and the server stays in it until you end it.

Start maintenance mode

1. Go to Administration, then Maintenance.
2. Under Maintenance mode, optionally type a Reason shown on the maintenance page, such as “Replacing the library disk”. A preview shows what people will see.
3. Choose Start maintenance and confirm.

You can also start it from the command line, from your Compose folder:

docker compose exec immich-server frameleaf-admin enable-maintenance-mode

The command prints a sign-in address for the maintenance page:

Maintenance mode has been enabled.

Log in using the following URL:
https://photos.example.com/maintenance?token=<token>

End maintenance mode

Sign in on the maintenance page as an administrator and end it there, or run:

docker compose exec immich-server frameleaf-admin disable-maintenance-mode

Signing in during maintenance

Maintenance mode uses its own sign-in, which is handled for you in most cases: if you start it from Administration, you’re signed in to the maintenance page automatically when the server comes back.

If you find yourself signed out:

• Look in the server logs (docker compose logs immich-server) for the maintenance mode message followed by a sign-in address. The address uses the server’s external domain or public server URL. If the server has neither, it prints only the path (/maintenance?token=…); open that path on the address you normally use to reach Frameleaf.
• Run enable-maintenance-mode again. While maintenance mode is on, it issues a new sign-in address.
• Or run disable-maintenance-mode, sign in normally, and start maintenance again from Administration.

See Server commands for how to run commands.