Synology package files - Revision history

imported>Johayek at 15:39, 31 January 2015

2015-01-31T15:39:19Z

← Older revision		Revision as of 15:39, 31 January 2015
Line 114:		Line 114:
	===Example===		===Example===
	You can find a example .spk file 'curcon' at http://www.mertymade.com/syno/. After installing this package, you will notice a 3rdpary entry in the navigation tree on the left with the name 'Current Connections'. When clicking on it, it will show all network and windows filesharing connections from/to the diskstation. It isn't that spectacular, but a good working example how to use packages and 3rdparty option.		You can find a example .spk file 'curcon' at http://www.mertymade.com/syno/. After installing this package, you will notice a 3rdpary entry in the navigation tree on the left with the name 'Current Connections'. When clicking on it, it will show all network and windows filesharing connections from/to the diskstation. It isn't that spectacular, but a good working example how to use packages and 3rdparty option.

			[[Category:SynologyWiki]]
			[[Category:ToBeExported]]

imported>Johayek: 16 revisions imported: imported from forum.synology.com/wiki

2015-01-31T15:33:22Z

16 revisions imported: imported from forum.synology.com/wiki

← Older revision	Revision as of 15:33, 31 January 2015
(No difference)

imported>Propletar: Undo revision 6499 by Upinson (talk)

2012-08-31T21:09:22Z

Undo revision 6499 by Upinson (talk)

Show changes

imported>Upinson: /* Example */

2012-08-31T13:15:42Z

Example

Show changes

imported>Merty: /* Package Structure */ added the 88f6282

2011-09-17T17:15:58Z

Package Structure: added the 88f6282

← Older revision		Revision as of 17:15, 17 September 2011
Line 26:		Line 26:
	\|- valign="top"		\|- valign="top"
	\|'''arch'''		\|'''arch'''
	\|CPU Architecture. "noarch" if it will fit all DiskStations. Other "arch" values can be "x86", "88f6281", "88f5281", "ppc853x" or "ppc854x", depending on the [[What kind of CPU_does my NAS have\|CPU]]. For models with the PPC 8241 CPU there are two different values for "arch" depending on the Linux version. It is "powerpc" for Linux 2.4 and "ppc824x" for Linux 2.6. Calling "uname -r" on a shell shows the Linux version.		\|CPU Architecture. "noarch" if it will fit all DiskStations. Other "arch" values can be "x86", "88f6281", "88f6282", "88f5281", "ppc853x" or "ppc854x", depending on the [[What kind of CPU_does my NAS have\|CPU]]. For models with the PPC 8241 CPU there are two different values for "arch" depending on the Linux version. It is "powerpc" for Linux 2.4 and "ppc824x" for Linux 2.6. Calling "uname -r" on a shell shows the Linux version.
	\|- valign="top"		\|- valign="top"
	\|'''adminport'''		\|'''adminport'''

85.218.49.219: /* Package Structure */

2011-09-07T21:00:46Z

Package Structure

← Older revision		Revision as of 21:00, 7 September 2011
Line 38:		Line 38:
	\|- valign="top"		\|- valign="top"
	\|'''reloadui'''		\|'''reloadui'''
	\|optional. Set to "yes" if there is a need to refresh the complete browser screen after starting (like adding/enabling icons in left pane.		\|optional. Set to "yes" if there is a need to refresh the complete browser screen after starting (like adding/enabling icons in left pane).
	\|- valign="top"		\|- valign="top"
	\|'''package_icon'''		\|'''package_icon'''
	\|optional. Base64 encoded icon of the package, used by DSM 3.2 and up. ~~Format~~ is ~~PNG~~, ~~and~~ the size is 72x72.		\|optional. Base64 encoded icon of the package, used by DSM 3.2 and up. The size is free, but the display size is 72x72, regardless of the aspect ratio.
	\|}		\|}
	\|- valign="top"		\|- valign="top"

85.218.49.219: /* Package Structure */

2011-09-06T22:04:30Z

Package Structure

← Older revision		Revision as of 22:04, 6 September 2011
Line 39:		Line 39:
	\|'''reloadui'''		\|'''reloadui'''
	\|optional. Set to "yes" if there is a need to refresh the complete browser screen after starting (like adding/enabling icons in left pane.		\|optional. Set to "yes" if there is a need to refresh the complete browser screen after starting (like adding/enabling icons in left pane.
			\|- valign="top"
			\|'''package_icon'''
			\|optional. Base64 encoded icon of the package, used by DSM 3.2 and up. Format is PNG, and the size is 72x72.
	\|}		\|}
	\|- valign="top"		\|- valign="top"

imported>Zebulon501: /* Package Structure */ Reformating

2011-02-24T22:30:42Z

Package Structure: Reformating

Show changes

imported>Zebulon501: Additions around the use of the spk scripts

2011-02-24T21:30:47Z

Additions around the use of the spk scripts

← Older revision		Revision as of 21:30, 24 February 2011
Line 8:		Line 8:
	'''INFO'''<BR>		'''INFO'''<BR>
	This is a file containing information that will be displayed and used during installation. It consists of multiple key="value" lines. The following keys are used:		This is a file containing information that will be displayed and used during installation. It consists of multiple key="value" lines. The following keys are used:
	::*'''package''' : The - unique! - name of the package, as will be displayed during install, in ~~packagemanager~~ overview and will be used as directory name under which the whole package will reside.		::*'''package''' : The - unique! - name of the package, as will be displayed during install, in package manager overview and will be used as directory name under which the whole package will reside.
	::*'''version''' : guess what...		::*'''version''' : guess what...
	::*'''maintainer''': Who is the 'owner' of the package. Only used for information purposes		::*'''maintainer''': Who is the 'owner' of the package. Only used for information purposes
Line 16:		Line 16:
	::*'''adminurl''': optional. If the program is installed and has it own "administration" webpage, this will be the rest of the url. (URL becomes <nowiki> http://own-name-of-nas:adminport/adminurl </nowiki>)		::*'''adminurl''': optional. If the program is installed and has it own "administration" webpage, this will be the rest of the url. (URL becomes <nowiki> http://own-name-of-nas:adminport/adminurl </nowiki>)
	::*'''firmware''': optional. Minimum version of DSM firmware that is required to run the package.		::*'''firmware''': optional. Minimum version of DSM firmware that is required to run the package.
	::*'''reloadui''': optional. Set to "yes" if there is a need to refresh the complete ~~browserscreen~~ after starting (like adding/enabling icons in left pane.		::*'''reloadui''': optional. Set to "yes" if there is a need to refresh the complete browser screen after starting (like adding/enabling icons in left pane.
	'''package.tgz'''<BR>		'''package.tgz'''<BR>
	This is a compressed (gzip) tar file containing all the files that are needed. The installer will automatically unpack this package.The file has to have this name exactly, otherwise installation will end with an error "invalid file format".<BR>		This is a compressed (gzip) tar file containing all the files that are needed. The installer will automatically unpack this package.The file has to have this name exactly, otherwise installation will end with an error "invalid file format".<BR>
Line 28:		Line 28:
	::* '''postupgrade'''		::* '''postupgrade'''
	::* '''start-stop-status'''		::* '''start-stop-status'''
	all 'inst' scripts are used during installation and uninstallation of the package. Returning anything other then '0' as result will break the installation or uninstallation. ~~Preinst~~ will be called before anything is installed (this is the place to check if all installation requirements are met, for example), ~~Postinst~~ after (to set the file rights of the installed files, for example). Same fore the "uninst" but then when using the 'uninstall' button on the package manager page. If a package is installed via the "upgrade" functionality of the ~~packagemanager~~, two scripts will be called: ~~pre-~~ and postupgrade. The start-stop-status script will be ~~called~~ by the package manager. ~~This script~~ will always be given an argument via the package manager. ~~<BR>~~		all '''*inst''' scripts are used during installation and uninstallation of the package. Returning anything other then '0' as result will break the installation or uninstallation. '''preinst''' will be called before anything is installed (this is the place to check if all installation requirements are met, for example), '''postinst''' after (to set the file rights of the installed files, for example).
	Hitting "run" in packagemanager will start this script with the 'start' argument, 'stop' result in 'stop'. When (re-)loading the ~~packagemanager~~ page, it will also call the script for a 'status' update. Finally, there is the possibility to show the log file via the info window. In all cases, returning '0' means 'all ok' and '1' means 'error occurred' or 'not running' (when checking status). When given the 'log' argument in the start-stop-status script, you are able to echo the filename of the logfile to STDOUT and the content of that file will be displayed under the 'log' tab of the info window.
			Same fore the '''*uninst''' but then when using the 'uninstall' button on the package manager page.

			If a package is installed via the "upgrade" functionality of the package manager, two scripts will be called: '''preupgrade''' and '''postupgrade'''. The '''*upgrade''' scripts used are the one from the new version of the package. It is worth to note here that nothing is checking the version of the package that is upgraded. Packages can be downgraded and reinstalled using the "upgrade" button of the package manager.

			The start-stop-status script will be used by the package manager to start, stop, and get the running status of the package once installed. It will be copied in the directory '''/usr/local/etc/rc.d/<packageName>.sh''' and run from this place. It will always be given an argument via the package manager. Hitting "run" in packagemanager will start this script with the '''start''' argument, '''stop''' result in '''stop'''. When (re-)loading the package manager page, it will also call the script for a '''status''' update. Finally, there is the possibility to show the log file via the info window. In all cases, returning '0' means 'all ok' and '1' means 'error occurred' or 'not running' (when checking status). When given the 'log' argument in the start-stop-status script, you are able to echo the filename of the logfile to STDOUT and the content of that file will be displayed under the 'log' tab of the info window.

	===Installation process===		===Installation process===

imported>Zebulon501: /* Adding a 3rdparty program into a package */

2010-05-15T21:12:52Z

Adding a 3rdparty program into a package

← Older revision		Revision as of 21:12, 15 May 2010
Line 39:		Line 39:
	Even before the firmware 722, it was possible to create a '3rdparty' option in the disk station manager. Using the package installer, this will become much easier to do.		Even before the firmware 722, it was possible to create a '3rdparty' option in the disk station manager. Using the package installer, this will become much easier to do.
	It's quite simple:		It's quite simple:
	# ~~Create~~ an application.cfg file and image directory as described in '3rd party apps integration guide'		# To install your application on the DSM Management Menu, create an application.cfg file and image directory as described in '3rd party apps integration guide'
			# To install your application on the DSM Desktop, create a desktop.cfg file.
	# place that file along with program files, images, cgi scripts and all in ''package.tgz''		# place that file along with program files, images, cgi scripts and all in ''package.tgz''
	# Create a softlink (ln -s ) from /usr/syno/synoman/3rdparty/webman/$SYNOPKG_PKGNAME to $SYNOPKG_PKGDEST in your ''postinst'' script and make sure link is removed in the ''postuninst''		# Create a softlink (ln -s ) from /usr/syno/synoman/3rdparty/webman/$SYNOPKG_PKGNAME to $SYNOPKG_PKGDEST in your ''postinst'' script and make sure link is removed in the ''postuninst''
Line 45:		Line 46:
	# Create other files (scripts, INFO) and pack them (tar -cvf whatevername.spk *) into a .spk .		# Create other files (scripts, INFO) and pack them (tar -cvf whatevername.spk *) into a .spk .

	~~Thats~~ it. By installing it, it will also create a 3rdparty directory. If you press 'reload' you will see the package can also be found in the navigation tree. Uninstallation removes all the files of the package, including the softlink.		That's it. By installing it, it will also create a 3rdparty directory. If you press 'reload' you will see the package can also be found in the navigation tree. Uninstallation removes all the files of the package, including the softlink.

	===Tips for creating packages===		===Tips for creating packages===