← MacMeUpSparklerUser Guide
MACOS 11 AND LATERNO APPLE IDEDDSA SIGNED

Sign your app updates.

Sparkler creates signed Sparkle appcasts and disk images for apps you host yourself, with no notarization and no Apple Developer account.

Generate an appcastVerify UploadGet Sparkler

1. Drop your file

Drop a .app, .exe, ZIP or folder onto Sparkler.

2. Check the details

Confirm the version, title and Update File URL.

3. Generate and upload

Click Generate Appcast, then upload the file Sparkler names.

4. You stay in control

Everything stays on your Mac until you upload it. Use Verify Upload to confirm.

Generate an appcast

Turn an update file into a signed Sparkle appcast.

Drop or select

Drop a .app, .exe, ZIP file or folder onto the window, or click Select File. Sparkler reads the version and app name for you.

Update File URL

Pick the saved URL where the update will be hosted. This field is required.

Release Notes

Edit the HTML release notes, or import a changelog file.

Generate Appcast

Signs the file with your EdDSA key and writes appcast.xml (or appcast-windows.xml for an .exe) next to the source file.

HOW TO
  1. Drop your app or installer onto the window.
  2. Check the version, title and Update File URL.
  3. Click Generate Appcast.
  4. Upload the file named in the result message, plus the appcast, to your server.
Tip Upload the exact file Sparkler names in the result. Changing it after signing breaks the signature.

Windows installers

Sign a Windows .exe on your Mac.

Signed as is

A dropped .exe is not zipped. The .exe itself is signed, and the appcast length and signature describe that exact file.

Windows appcast

The appcast is saved as appcast-windows.xml and includes sparkle:os="windows".

Version from filename

A name like MyApp-1.2.3.exe or MyApp_1.2.3_Setup.exe gives version 1.2.3.

Same key

Windows and macOS updates use the same EdDSA key. The Windows app must contain the matching public key.

Careful Windows updaters need WinSparkle 0.8.0 or later for EdDSA signatures.

Verify Upload

Check that your server serves the file you signed.

What it does

Downloads the file at your Update File URL without any cache and compares its size and SHA-256 with the signed local file.

If it matches

The server copy is byte-identical, so the appcast signature and size are valid.

If it differs

Sparkler reports the HTTP status and explains likely causes: an error page, a stale CDN copy, a truncated upload, or an FTP upload in text mode.

HOW TO
  1. Generate the appcast and upload the file.
  2. Click Verify Upload.
  3. Read the result in the sidebar.
Tip A Cloudflare 525 error means Cloudflare could not complete an SSL handshake with your server. Fix the server certificate, then purge the cache.

Applications URL

Save the download URLs for each app once.

Add New URL

Enter an App Name, an Update File URL and an optional Release Notes URL.

Auto-detect

When you drop an app, Sparkler matches it to a saved URL by its real name.

Edit or remove

Change or delete a saved URL from the list on the Applications URL tab.

Create a DMG

Build a disk image from a dropped .app.

Engine

Use the built-in engine (nothing to install) or the external create-dmg tool.

Window and icons

Set the window size, icon size and background image.

Background text

Add text with position dropdowns, font size and font weight.

Volume icon

Pick a custom icon or one of three bundled icons, or turn on Use Generic Volume Icon for the standard macOS disk icon.

Signing and ZIP

Optionally sign the DMG, create a .dmg.zip and add the version to the filename.

Keys and tools

Manage the signing setup.

EdDSA keys

Sparkler uses the key stored in your Keychain, or creates one if none exists.

Sparkle tools

Use the bundled tools or choose your own folder in Settings > Sparkle.

Validate Setup

Checks your public key and the Sparkle framework inside a dropped app.

Careful Without the Sparkle tools Sparkler will not write an appcast, because it cannot sign the file.

Settings

Open Settings with the gear icon in the toolbar.

SectionWhat it controls
GeneralAuto-extract app info, detailed error messages, preserve file locations, bundle appcast and archive.
UpdatesSparkler’s own automatic update checks.
SparkleSparkle tools location and EdDSA keys.
AboutVersion, credits and donation.

Shortcuts

Keyboard shortcuts.

KeysAction
⌘OSelect ZIP file
⌘WClose window
⌘⌃SToggle sidebar

Frequently Asked Questions

Got questions? We've got answers.

Why does my update say it is improperly signed?

The file on the server is not the file that was signed, or the public key in your app does not match your EdDSA key. Use Verify Upload to compare the server copy with the signed file.

What is the Release ZIP?

With Bundle Appcast and Archive on, Sparkler also makes a ZIP holding the appcast and the update file for convenience. Do not upload it as the update itself.

Why do I get a 525 error from my server?

525 is a Cloudflare error: it could not complete an SSL handshake with your origin server. Check the origin SSL certificate and Cloudflare’s SSL mode.

A new upload still serves the old file.

A CDN may be caching the old copy. Purge the cache or use a new filename for each release.

Does Sparkler need an Apple ID or notarization?

No.