summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTobias Markmann <tm@ayena.de>2016-09-22 15:07:33 (GMT)
committerKevin Smith <kevin.smith@isode.com>2016-09-26 22:04:24 (GMT)
commit05fbe78f5c3b30517f7152b37c157a99120682dc (patch)
tree865ffa3fdcf73d8044c3478ef8e52b159c3fc738 /DEVELOPMENT.md
parent82d4ca00958d6d097aee830ac300ecfd9014d2b3 (diff)
downloadswift-05fbe78f5c3b30517f7152b37c157a99120682dc.zip
swift-05fbe78f5c3b30517f7152b37c157a99120682dc.tar.bz2
Update and tidy up Sparkle software update support
Sparkle is configured to do silent automatic background updates based on the provide appcast feed. When a new update was downloaded and is ready to be installed Swift notifies the user that they can restart to take advantage of the newly available version. Test-Information: Setup a custom appcast feed with a newer Swift dev release. Tested updating with Sparkle 1.14.0 binary release using DSA keys and signatures. Did not test Sparkle update with code signed Swift builds. Tested on macOS 10.12. Change-Id: Idad461ec53963c80990e51a502cb6e28bc7b6b4e
Diffstat (limited to 'DEVELOPMENT.md')
-rw-r--r--DEVELOPMENT.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 2b8ca99..3d9c1a7 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -68,6 +68,25 @@ Notes:
paths
- Currently only 32-bit builds of the Swift client are supported
+## Automatic Software Updates
+Automatic software updates allow distribution of updates directly to the end users.
+This is useful for general feature updates, bug fixes and especially for security
+updates.
+
+### Automatic Software Updates for Mac OS X using Sparkle
+Swift supports integration with the software update framework [Sparkle](https://sparkle-project.org/) on OS X. For security reasons,
+Sparkle requires the application to be either code-signed or a bundled public DSA
+key. In case you do not code-sign, you can provide the path to the public DSA key
+to be bundled with the application bundle via the `sparkle_public_dsa_key` SCons
+argument.
+
+To build with Sparkle support, simply download Sparkle-1.14.0 and extract it to
+`3rdParty/Sparkle/Sparkle-1.14.0`. SCons will pick it up during configuration
+and build Swift with Sparkle support.
+
+The appcast URL is specified as a compile time preprocessor variable `SWIFT_APPCAST_URL`
+in `Swift/QtUI/QtSwift.cpp`
+
## Building Swiften for Android
This section describes how to build Swiften for Android. It can then be used from any Android native code. This guide has been tested on OS X and Linux.