Keep it running

A trial removes itself after an hour. A kept app stays up until you remove it, and Setup looks after it: it checks that the app answers, emails you when it goes down, and can update it and back up its data on a schedule.

Health checks, emails and daily backups need nothing from you. Automatic updates are off until you turn them on in the app's Settings tab.

Keep a trial

Press Keep it on the app's page any time before the trial ends. In the simple view it's Keep it under Keep this app. You can also tell the assistant "keep it", or use the button in the email Setup sends ten minutes before a trial ends.

To skip the trial, choose Keep it running (detailed view) or Keep it (simple view) before you start the app.

Note. Once a trial has ended, the app and its data are gone. Start it again from the catalog or paste the link again.

Updates

An update moves an app to a newer revision of its recipe. Setup redeploys it with the new recipe and keeps its data, its settings and its address.

Where new revisions come from

A newer revision appears when the catalog recipe changes, when someone analyzes the project again or edits its recipe, or when a kept GitHub or GitLab project outside the catalog has a new release (or, without releases, a new commit). Setup checks for those at most once a day and never replaces a recipe someone edited by hand.

Manual updates

When a revision is available, the app's page says so. Review update shows what changes, service by service, with secret values hidden. Update to revision 3 (with the new revision's number) applies it. In the simple view, Update does the same without the details.

Automatic updates

Turn on Automatic updates in the app's Settings tab, and Setup applies new revisions on its own while the app is running and no other job is busy with it. A revision that needs new settings waits for you; the app's activity says so.

Rollback

If an updated app fails its checks, Setup goes back to the revision it ran before, on its own. Automatic updates then skip the failed revision until a newer one is published. You can still try it yourself with Try revision 3 again.

Backups and restore

A backup is a copy of everything the app stores. To keep the copy consistent, the runner stops the app's services, archives the data and starts them again, so the app is offline for the moment that takes.

• Back up now. In the Backups tab, or Back up now in the simple view, or ask the assistant.
• Scheduled backups. A kept app is backed up Daily from the start: keeping a trial or starting an app as kept turns the schedule on. In the Settings tab you can change Backup schedule to Weekly or Off.
• Backups to keep. After each new backup, the oldest ones beyond this number are deleted. The default keeps 7, or 4 with a weekly schedule. The Settings tab offers 3, 7, 14 or 30; the API accepts up to 90.
• Restore. Restore next to a backup in the Backups tab, or ask the assistant. Setup stops the app, replaces its data with that backup, starts it again and runs its checks. Everything changed since that backup is lost.

Backups are stored on the runner that hosts the app: on your own machine if you connected one, otherwise on Setup Cloud. If a backup fails, the app keeps running, earlier backups stay untouched, and Setup emails you.

Note. Removing an app doesn't delete its backup archives from the runner's disk today, but Setup can't restore them afterwards. On a runner of your own they sit in the backups folder of the runner's data directory.

Health checks and restarts

While a kept app runs, its runner checks it about every 30 seconds: are all its services running, and does its web page answer the recipe's check? The Health tab shows uptime, response times, memory and CPU.

Kept apps run under Docker's unless-stopped restart policy, so a service that crashes starts again by itself. If the app is still down after 5 minutes, Setup records an incident and emails you, keeps checking, and emails again once it has been back up for a minute. Planned downtime, such as a stop, an update or a backup, never counts.

Setup doesn't rebuild an app on its own. To do that, press Restart (simple view), Redeploy at the bottom of the Settings tab (detailed view), or ask the assistant to restart it. Its data stays.

Email alerts

Setup emails the people who look after a kept app. For an app called Immich, the subjects read:

Each problem is emailed once, not every minute it lasts. For apps in your personal workspace, the emails go to you. For apps in a team workspace, they go to the team's owners and admins and to the member who started the app. Emails use the language you chose for the interface.

Choose which emails you get under My account (/dashboard/account), in Email notifications: Failures and downtime, Failed backups, Updates and Trials ending. These switches apply to all your apps.

Public status pages

A status page is a public page anyone with the link can open. It shows the app's name, its current state ("Up and running", "Down", "Being updated" and so on), the daily uptime of the last 90 days and the last incident.

Turn it on in the app's Settings tab with Public status page, then copy the link. Status pages exist only for kept apps and never show your workspace, the runner, logs or error messages. The app's own address appears only if you also turn on Show the address; leave that off for private apps.

The link has the form /status/immich-x7k2qa: the app's short name and six random characters.

How uptime is counted

Uptime is the share of checks in which the app was up. The Health tab shows the last 24 hours, the last 7 days and one bar per day for the last 30 days; status pages show 90 days. Time without checks, because the runner was offline or you stopped the app, counts as "no data", not as downtime.