diff --git a/documentation/package-updates/index.md b/documentation/package-updates/index.md index 44b2c1a..61366c8 100644 --- a/documentation/package-updates/index.md +++ b/documentation/package-updates/index.md @@ -9,8 +9,16 @@ Guided Package Installation allows Sparkle to download and install a package, `p ### Deploying a Package -A guided installation occurs when Sparkle finds a `*.sparkle_guided.pkg` or `*.sparkle_guided.mpkg` in the root of the download. +#### Automatic installation + +A guided installation occurs when Sparkle finds a `*.pkg` or `*.mpkg` file in the root of the download archive ([older versions](/documentation/upgrading/) of Sparkle required the filename to be `*.sparkle_guided.pkg`). The installer package is installed using macOS's built-in command line installer, `/usr/sbin/installer`. No installation interface is shown to the user. A guided installation can be started by applications other than the application being replaced. This is particularly useful where helper applications or agents are used. + +#### Interactive GUI Installer + +An interactive installation occurs when Sparkle finds a `*.sparkle_interactive.pkg` or `*.sparkle_interactive.mpkg` file in the root of the download archive. + +The package will be installed using macOS's built-in GUI installer. The installation will require user to manually click through the steps, so we don't recommend this type of installation. diff --git a/documentation/upgrading/index.md b/documentation/upgrading/index.md index 517c5f4..f663c61 100644 --- a/documentation/upgrading/index.md +++ b/documentation/upgrading/index.md @@ -4,9 +4,11 @@ id: documentation title: Upgrading from previous versions of Sparkle --- -We strongly recommend using Sparkle 1.13.1 or later, as there have been important fixes in reliability and [security](/documentation/security) of updates. Very old versions of Sparkle also suffer some incompatibilities with the latest macOS versions. +We strongly recommend upgrading Sparkle to the [latest version](//github.com/{{ site.github_username }}/Sparkle/releases), as there have been important fixes in reliability and [security](/documentation/security) of updates. Very old versions of Sparkle also suffer some incompatibilities with the latest macOS versions. -If you're upgrading from a very old version of Sparkle we recommend using [Sparkle 1.14 or later](//github.com/{{ site.github_username }}/Sparkle/releases). The API is backwards-compatible. +## Upgrading from Sparkle 1.15 and older + +For updates that [use the `.pkg` format](https://sparkle-project.org/documentation/package-updates/), Sparkle no longer shows the full Installer GUI by default. Rename your `.pkg` file to `.sparkle_interactive.pkg` to keep the old behavior. ## Upgrading to SDK 10.11 (affects all versions of Sparkle)