Skip to content
A software update framework for macOS
Objective-C Swift Python Shell Makefile Ruby C
Branch: master
Clone or download
kornelski Merge pull request #1458 from BitShift-Tech/appcast-generation-file-e…
…xtention

SUFeedUrl generate appcast file extension (let fix)
Latest commit d522235 Aug 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Add issue templates Feb 24, 2019
Configurations Build with hardened runtime Jun 29, 2019
Documentation 2 tiny fixes Nov 20, 2018
Resources
Sparkle.xcodeproj Processed requested changes Aug 13, 2019
Sparkle
TestApplication
Tests Phased rollout interval is an appcast item attribute and not its own … Apr 2, 2019
UITests
Vendor Move ed25519 dependency to the Vendor directory May 28, 2019
bin/old_dsa_scripts Make legacy script use a smaller DSA key that macOS still supports Nov 13, 2018
fileop
generate_appcast
generate_keys
objc_dep
sign_update
.clang-format Comment problematic clang-format property. Jun 6, 2015
.gitignore Add Carthage/Build to .gitignore Jul 22, 2016
.gitmodules Move ed25519 dependency to the Vendor directory May 28, 2019
.travis.yml Update Xcode version for Travis CI Aug 14, 2017
CHANGELOG Changelog Jun 29, 2019
CODE_OF_CONDUCT.md CoC Sep 2, 2016
LICENSE
Makefile
Makefile-icon
README.markdown Update README.markdown Apr 14, 2019
Sparkle.podspec

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 EdDSA 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.
  • 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.
  • Ability to mark updates as critical.
  • Progress and status notifications for the host app.

Requirements

  • Runtime: macOS 10.7 or greater
  • Build: Xcode 9 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

This repository uses git submodules, and will not build unless you clone recursively. Also, GitHub-provided ZIP/tar archives are broken due to GitHub not supporting git submodules properly.

git clone --recursive https://github.com/sparkle-project/Sparkle

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

You can’t perform that action at this time.