A software update framework for macOS
Latest commit 5acf398 Nov 13, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Configurations Build new scripts Sep 16, 2018
Documentation add tips for user to install doxygen May 25, 2018
Resources sign_update tool Sep 16, 2018
Sparkle.xcodeproj Croatian localization added Nov 10, 2018
Sparkle Croatian localization added Nov 10, 2018
TestApplication Croatian localization added Nov 10, 2018
Tests Ignore symlink permissions in binary deltas Oct 31, 2018
UITests Fix UITests multiple matches issue introduced in touch bar Jan 8, 2017
Vendor/bsdiff Change dmg and test verifying code by removing NTSynchronousTask Aug 27, 2016
bin/old_dsa_scripts Make legacy script use a smaller DSA key that macOS still supports Nov 13, 2018
ed25519 @ 7fa6712 ed25519 submodule Sep 15, 2018
fileop Explicitly specify types to silence "Messaging unqualified id" warnin… Jun 14, 2018
generate_appcast EdDSA spelling Sep 17, 2018
generate_keys ed25519 keys in generate_* tools Sep 15, 2018
objc_dep Detect and fail if any two-way dependencies exist in the project Feb 6, 2017
sign_update EdDSA spelling Sep 17, 2018
.clang-format Comment problematic clang-format property. Jun 6, 2015
.gitignore Add Carthage/Build to .gitignore Jul 22, 2016
.gitmodules ed25519 submodule Sep 15, 2018
.travis.yml Update Xcode version for Travis CI Aug 14, 2017
CHANGELOG Bump Oct 31, 2018
CODE_OF_CONDUCT.md CoC Sep 2, 2016
LICENSE Add my name to LICENSE Feb 2, 2017
Makefile "all" target Mar 18, 2018
Makefile-icon Rename Sparkle.icns to be consistent with ASSETCATALOG_COMPILER_APPIC… Nov 9, 2016
README.markdown Troubleshooting help Nov 12, 2018
Sparkle.podspec Bump Jul 17, 2018

README.markdown

Sparkle Build Status Carthage compatible CocoaPods sponsored by: StackPath

Secure and reliable software update framework for Cocoa developers.

Sparkle shows familiar update window with release notes

Features

  • Seamless. There's no mention of Sparkle; your icons and app name are used.
  • Secure. Updates are verified using DSA signatures and Apple Code Signing.
  • Fast. Supports delta updates which only patch files that have changed.
  • Easy to install. Sparkle requires no code in your app, and only needs static files on a web server.
  • Supports bundles, preference panes, plugins, and other non-.app software. Can install .pkg files for more complicated products.
  • Handles permissions, quarantine and automatically asks for authentication if needed.
  • Uses RSS-based appcasts for release information. Appcasts are a de-facto standard supported by 3rd party update-tracking programs and websites.
  • Sparkle stays hidden until second launch for better first impressions.
  • Truly self-updating — the user can choose to automatically download and install all updates in the background.

Changes since 1.5b

  • Compatibilty with macOS Sierra (and all newer versions).
  • Up-to-date with 10.13 SDK and Xcode 9 (supports macOS 10.7+).
  • Important security fixes.
  • Cleaned up and modernized code, using ARC and Autolayout.
  • Truly automatic background updates (no UI at all) when user agreed to "Automatically download and install updates in the future."
  • Upgraded and more reliable binary delta and code signing verification.
  • Ability to mark updates as critical.
  • Progress and status notifications for the host app.

Requirements

  • Runtime: macOS 10.7 or greater
  • Build: Xcode 8 and 10.11 SDK or greater
  • HTTPS server for serving updates (see App Transport Security)
  • No sandboxing. Sparkle 1.x can't update sandboxed apps. Sparkle 2.0 (alpha) can.

Usage

See getting started guide. No code is necessary, but a bit of Xcode configuration is required.

Development

Troubleshooting

  • Please check Console.app. Sparkle prints detailed information there about all problems it encounters. It often also suggests solutions to the problems, so please read Sparkle's log messages carefully.

  • Use the generate_appcast tool which creates appcast files, correct signatures, and delta updates automatically.

  • Make sure the URL specified in SUFeedURL is valid (typos/404s are a common error!), and that it uses modern TLS (test it).

  • Delete your app's preferences (in ~/Library/Preferences/<your bundle id>) if you've set another feed URL programmatically via Sparkle's Objective-C interface.

API symbols

Sparkle is built with -fvisibility=hidden -fvisibility-inlines-hidden which means no symbols are exported by default. If you are adding a symbol to the public API you must decorate the declaration with the SU_EXPORT macro (grep the source code for examples).

Building the distribution package

cd to the root of the Sparkle source tree and run make release. Sparkle-VERSION.tar.bz2 will be created in a temporary directory and revealed in Finder after the build has completed.

Alternatively, build the Distribution scheme in the Xcode UI.

Code of Conduct

We pledge to have an open and welcoming environment. See our Code of Conduct.

Project Sponsor

StackPath