Remove instructions for sandboxing downloader XPC Service (#218)

I think it's potentially confusing implementation detail to some developers, provides a risk of developers configuring it wrong, and will not be common enough of an option. I may change my mind later.
This commit is contained in:
Zorg
2024-03-15 18:58:56 -07:00
committed by GitHub
parent 691b4074de
commit adfbe472dc
-1
View File
@@ -56,7 +56,6 @@ The downloader service allows using Sparkle without forcing the network client e
* We fall back to using WebKit's deprecated `WebView` for release notes due to a [known WKWebView defect](https://github.com/feedback-assistant/reports/issues/1). Please file a bug report on [WebKit's issues tracker](https://webkit.org/reporting-bugs/) or a Feedback Assistant report to Apple relating to FB6993802 preventing the use of WKWebView without having the `com.apple.security.network.client` entitlement on your sandboxed application. Emphasize that this defect blocks your app's adoption from WebKit1 to WebKit2.
* [Adapting release notes based on the currently installed version](/documentation/publishing#adapting-release-notes-based-on-currently-installed-version) is not supported because this feature is not implemented for Sparkle's legacy WebKit view.
* It may not work well if your release notes reference external content that would require making additional network requests.
* As of Sparkle 2.6, the Downloader XPC Service is not sandboxed by default. If you want to sandbox this service, you will need to uncomment `DOWNLOADER_SANDBOXED_ENTITLEMENTS` and modify `XPC_SERVICE_BUNDLE_ID_PREFIX` in Sparkle's `ConfigCommon.xcconfig` when building Sparkle from source. Sandboxing this XPC Service requires using a custom bundle ID for it, otherwise conflicts may arise with other sandboxed apps using the service.
To enable the service, you must set [SUEnableDownloaderService](/documentation/customization#sandboxing-settings) boolean to `YES` in your application's Info.plist.