spk - Synology's Package Format
Notes about the Synology spk format, used by DiskStation Manager's Package Center.
The Synology Dev Center is the official source of documentation for the spk
package format. Synology also publish open source tooling and sample packages. These are the authoritative resources for building Package Center packages.
spk
Extensions
Package Origin adds two fields to the spk INFO
file:
package_icon_url
package_snapshot_url
These are both a space separated list of URLs. URLs are escaped to avoid spaces within individual URLs.
package_icon_url
package_icon_url
is a list of space separated URLs that will be passed to Package Center when the package’s thumbnail icon is requested.
Requesting the URL should return a 256px square Portable Graphics Format (.png
) formatted image. Prefer a large icon size where available. DiskStation Manager (DSM) appears to cache and resize the image as required.
See Synology’s PACKAGE_ICON_256.PNG
file within the Package Structure documentation.
package_snapshot_url
package_snapshot_url
is a list of space separated URLs that will be passed to Package Center when the package’s snapshot image is requested.
Requesting the URL should return a screen shot suitable for display within the Package Center’s user interface.
See Synology’s Prepare Screenshots in the Submitting the Package for Approval for the documentation about these images.