OrchardDocs

Help

Updates

How Orchard updates itself, how to install an update, switch to canary builds, roll back, and repair an install.

Orchard downloads updates in the background and installs them the next time it starts. You never wait for an update when you open Orchard.

To see what changed in a build, open Settings > About > Release Notes. The notes are included with Orchard, so you can read them offline. About also shows the version of the app you are currently running.

Install a downloaded update

When an update is ready, Settings > General > Updates says “Update ready. Restart Orchard to install.” Select Restart. Orchard closes, switches to the new version, and opens again.

If you do nothing, the update installs the next time you start Orchard.

Check for updates now

Open Settings > General > Updates and select Check for updates. The row shows the download size while it downloads. Select Cancel to stop; the next check resumes where it stopped.

The Updates section only appears when Orchard was installed with the Orchard installer. Builds you compiled yourself do not update.

How big updates are

Orchard downloads only the files that changed. A typical update is 5 to 40 MB. Shared parts such as the Qt runtime, FFmpeg and the AI models download again only when they change.

Turn off automatic downloads

Turn off Download updates automatically in Settings > General > Updates. Orchard then downloads only when you select Check for updates.

Get canary builds

Turn on Canary builds in Settings > General > Updates. Orchard downloads the latest canary build right away. Turn it off to go back to stable builds; Orchard installs the current stable version even if it is older.

On Android, install the latest mobile prerelease (tagged -mobile) from the GitHub releases page.

Orchard went back to an older version

If a new version crashes twice right after it starts, Orchard returns to the previous version and skips the broken one. A later update replaces it.

To go back yourself, run the Orchard launcher with --rollback, for example Orchard.exe --rollback on Windows.

Repair a broken install

If Orchard does not start or reports missing files, run the Orchard launcher with --repair. It checks every installed file and downloads only the damaged or missing ones. Orchard also repairs itself automatically when the current version is incomplete.

Uninstall Orchard

On Windows, open Settings > Apps and uninstall Orchard. On Linux, run ~/.local/share/orchard/orchard --uninstall. Your library, settings and downloads are kept.