Deploying an Update Server - Revision history

Robbiej: Added deprecation notice and link to Joomla Manual

2024-06-27T11:47:43Z

Added deprecation notice and link to Joomla Manual

← Older revision		Revision as of 11:47, 27 June 2024
Line 1:		Line 1:
	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>
	<noinclude>{{Joomla version\|version=2.5\|status=eos}}{{Joomla version\|version=3.x\|}}{{Joomla version\|version=4.x\|}}</noinclude>		<noinclude>{{Joomla version\|version=2.5\|status=eos}}{{Joomla version\|version=3.x\|}}{{Joomla version\|version=4.x\|}}</noinclude>

			{{Warning\|This page has been superseded and is no longer maintained. Please go to [https://manual.joomla.org/docs/building-extensions/install-update/update-server Joomla Manual Update Servers] instead}}

	<translate>		<translate>

Max123kl: new wording

2021-11-25T06:55:24Z

new wording

← Older revision		Revision as of 06:55, 25 November 2021
Line 103:		Line 103:
	* '''folder''' – Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)</translate>		* '''folder''' – Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)</translate>
	<translate><!--T:23-->		<translate><!--T:23-->
	* '''client''' – Required for modules and templates as of 3.2.0~~. – The client of the extension~~. Possible values at this time are "site", "administrator". '''Warning!''' Plugins and front-end modules are automatically installed with a client of site, but you will need to specify the client in an update or it will default to administrator and then found update would not be shown because it would not match any extension. Components are automatically installed with a client of administrator, which is currently the default.</translate>		* '''client''' – The client of the extension. Required for modules and templates as of 3.2.0. Possible values at this time are "site" or "administrator". '''Warning!''' Plugins and front-end modules are automatically installed with a client of site, but you will need to specify the client in an update or it will default to administrator and then found update would not be shown because it would not match any extension. Components are automatically installed with a client of administrator, which is currently the default.</translate>
	<translate><!--T:24-->		<translate><!--T:24-->
	** ''Warning'': As of Joomla! 4.0 only a string is allowed. Using numbers as client has been deprecated in 2012 and got removed in Joomla! 4.0 (Replace 0 with "site" and 1 with "administrator")		** '''Warning''': As of Joomla! 4.0 only a string is allowed. Using numbers as client has been deprecated in 2012 and got removed in Joomla! 4.0 (Replace 0 with "site" and 1 with "administrator")
	** ''Warning'': The tag name is <'''client'''> for Joomla! 2.5 and <'''client_id'''> for 1.6 and 1.7. If you use <client_id> (rather than <client>) on a 2.5 site, it will be ignored.</translate>		** '''Warning''': The tag name is <'''client'''> for Joomla! 2.5 and <'''client_id'''> for 1.6 and 1.7. If you use <client_id> (rather than <client>) on a 2.5 site, it will be ignored.</translate>
	<translate><!--T:25-->		<translate><!--T:25-->
	* '''version''' – The version of the release (required)</translate>		* '''version''' – The version of the release (required)</translate>

Hleithner: Updated client description

2021-10-15T11:54:57Z

Updated client description

← Older revision		Revision as of 11:54, 15 October 2021
Line 103:		Line 103:
	* '''folder''' – Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)</translate>		* '''folder''' – Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)</translate>
	<translate><!--T:23-->		<translate><!--T:23-->
	* '''client''' – Required for modules and templates as of 3.2.0. – The client ID of the extension~~, which can be found by looking inside the #_extensions table~~. ~~To date, use 0 for~~ "site" ~~and 1 for~~ "administrator". '''Warning!''' Plugins and front-end modules are automatically installed with a client of ~~0 (~~site), but you will need to specify the client in an update or it will default to ~~1 (~~administrator) and then found update would not be shown because it would not match any extension. Components are automatically installed with a client of 1, which is currently the default.</translate>		* '''client''' – Required for modules and templates as of 3.2.0. – The client of the extension. Possible values at this time are "site", "administrator". '''Warning!''' Plugins and front-end modules are automatically installed with a client of site, but you will need to specify the client in an update or it will default to administrator and then found update would not be shown because it would not match any extension. Components are automatically installed with a client of administrator, which is currently the default.</translate>
	<translate><!--T:24-->		<translate><!--T:24-->
			** ''Warning'': As of Joomla! 4.0 only a string is allowed. Using numbers as client has been deprecated in 2012 and got removed in Joomla! 4.0 (Replace 0 with "site" and 1 with "administrator")
	** ''Warning'': The tag name is <'''client'''> for Joomla! 2.5 and <'''client_id'''> for 1.6 and 1.7. If you use <client_id> (rather than <client>) on a 2.5 site, it will be ignored.</translate>		** ''Warning'': The tag name is <'''client'''> for Joomla! 2.5 and <'''client_id'''> for 1.6 and 1.7. If you use <client_id> (rather than <client>) on a 2.5 site, it will be ignored.</translate>
	<translate><!--T:25-->		<translate><!--T:25-->

Zero24 at 19:01, 23 August 2021

2021-08-23T19:01:29Z

← Older revision		Revision as of 19:01, 23 August 2021
Line 130:		Line 130:
	** '''NB''' – there must be no newline before or after the URL; it needs to all be on one line or you will get Error connecting to the server: malformed when the update is run</translate>		** '''NB''' – there must be no newline before or after the URL; it needs to all be on one line or you will get Error connecting to the server: malformed when the update is run</translate>
	<translate><!--T:32-->		<translate><!--T:32-->
			* '''changelogurl''' - A link to an xml file holding the changelog. Joomla 4.0 and later will allow you to show a button for the changelog in the extension updater page. More details in how to use it can be found here: [[Adding changelog to your manifest file]]
	* '''tags''' – A list of tags relevant to this version. Joomla! 3.4 and later uses this to determine the stability level of the update. The valid tags are:</translate>		* '''tags''' – A list of tags relevant to this version. Joomla! 3.4 and later uses this to determine the stability level of the update. The valid tags are:</translate>
	<translate><!--T:33-->		<translate><!--T:33-->

Cmb: Added a note concerning the meaning of priority in relation to multiple servers.

2020-04-15T23:34:59Z

Added a note concerning the meaning of priority in relation to multiple servers.

← Older revision		Revision as of 23:34, 15 April 2020
Line 12:		Line 12:
	</translate>		</translate>
	<translate><!--T:4-->		<translate><!--T:4-->
	In order to use this feature, an update server must be defined in your extension's manifest. This definition can be used in all Joomla! 2.5 and newer compatible extensions but is not available for templates. You can use two options for your server type; collection or extension. These will be explained in detail shortly. This code should be added to the extension manifest file, within the root "extension" element. The update server is defined as follows for each type:</translate>		In order to use this feature, an update server must be defined in your extension's manifest. This definition can be used in all Joomla! 2.5 and newer compatible extensions but is not available for templates. You can use two options for your server type: collection or extension. These will be explained in detail shortly. This code should be added to the extension manifest file, within the root ''extension'' element. The update server is defined as follows for each type:</translate>

	<source lang="xml">		<source lang="xml">
Line 23:		Line 23:
	</extension>		</extension>
	</source>		</source>

	<translate><!--T:5-->		<translate><!--T:5-->
	Multiple servers can be defined within the <tt><updateservers></tt> tag.</translate>		Multiple servers can be defined within the <tt><updateservers></tt> tag. If you have more than one update server, you can set a different priority for each. In that way you can control the order in which the update servers are checked.</translate>

	<translate>		<translate>

	== Server types == <!--T:6-->		== Server types == <!--T:6-->
	</translate>		</translate>
Line 56:		Line 54:
	<translate><!--T:14-->		<translate><!--T:14-->
	* '''detailsurl''' – The URL of the XML file which contains that extension's individual update definitions</translate>		* '''detailsurl''' – The URL of the XML file which contains that extension's individual update definitions</translate>

	<translate>		<translate>

	=== Extension === <!--T:15-->		=== Extension === <!--T:15-->
	</translate>		</translate>
Line 179:		Line 175:
	<translate><!--T:49-->		<translate><!--T:49-->
	'''Important for plugins:''' Plugins have to include <folder> and <client> elements to work properly</translate>		'''Important for plugins:''' Plugins have to include <folder> and <client> elements to work properly</translate>

	<translate>		<translate>

	== Troubleshooting == <!--T:50-->		== Troubleshooting == <!--T:50-->
	</translate>		</translate>
Line 190:		Line 184:

	<translate>		<translate>

	== Supporting Tools == <!--T:53-->		== Supporting Tools == <!--T:53-->
	</translate>		</translate>

Wilsonge: Mark compat with 4.x

2020-03-30T16:42:54Z

Mark compat with 4.x

← Older revision		Revision as of 16:42, 30 March 2020
Line 1:		Line 1:
	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>
	<noinclude>{{Joomla version\|version=2.5\|status=eos}}{{Joomla version\|version=3.x\|}}</noinclude>		<noinclude>{{Joomla version\|version=2.5\|status=eos}}{{Joomla version\|version=3.x\|}}{{Joomla version\|version=4.x\|}}</noinclude>

	<translate>		<translate>

Wilsonge: Note how target platform interacts with 3.10 Joomla Update

2020-03-30T16:41:50Z

Note how target platform interacts with 3.10 Joomla Update

← Older revision		Revision as of 16:41, 30 March 2020
Line 152:		Line 152:
	* '''section''' – Optional (unknown use)</translate>		* '''section''' – Optional (unknown use)</translate>
	<translate><!--T:41-->		<translate><!--T:41-->
	* '''targetplatform''' – A tag to define platform requirements, requires the following elementsː</translate>		* '''targetplatform''' – A tag to define platform requirements (from {{ JVer\| 3.10 }} this is also used to detect extension compatibility for the Joomla Update component), requires the following elementsː</translate>
	<translate><!--T:42-->		<translate><!--T:42-->
	** '''name''' – The name of the platform dependency; as of this writing, it should ONLY be "joomla"</translate>		** '''name''' – The name of the platform dependency; as of this writing, it should ONLY be "joomla"</translate>
Line 160:		Line 160:
	** '''min_dev_level''' and '''max_dev_level''' – These attributes were added in 3.0.1 to allow you to select a target platform based on the developer level ("z" in x.y.z). They are optional. You can specify either one or both. If omitted, all developer levels are matched. For example, the following matches versions 4.0.0 and 4.0.1. <code><targetplatform name="joomla" version="4.0" min_dev_level="0" max_dev_level="1"/></code></translate>		** '''min_dev_level''' and '''max_dev_level''' – These attributes were added in 3.0.1 to allow you to select a target platform based on the developer level ("z" in x.y.z). They are optional. You can specify either one or both. If omitted, all developer levels are matched. For example, the following matches versions 4.0.0 and 4.0.1. <code><targetplatform name="joomla" version="4.0" min_dev_level="0" max_dev_level="1"/></code></translate>
	<translate><!--T:45-->		<translate><!--T:45-->
	*** '''Note:''' If your extension is Joomla! 2.5 and/or 3.1 compatible, you will be required to have separate <update> definitions for each version due to the manner in which the updater checks the version if you specify a number. However to show your extension on all Joomla versions that support automatic updates add <code><targetplatform name="joomla" version=".*"/></code>. If you want your extension to show on all {{JVer\|3.x}} versions then rather than specifying a version in the version tag add in <code><targetplatform name="joomla" version="3.[012345]"/></code>. This will show the update to all 3.x versions from version 3.0 to 3.5. If you want to include version 3.10 you can use an <code>\|</code> like this: <code><targetplatform name="joomla" version="3.[012345]\|10"/></code>. If you want to show the updates for all 3.8.x versions and all 3.10.x versions you can use <code><targetplatform name="joomla" version="3.(8\|10)"/></code></translate>		*** '''Note:''' If your extension is Joomla! 2.5 and/or 3.1 compatible, you will be required to have separate <update> definitions for each version due to the manner in which the updater checks the version if you specify a number. However to show your extension on all Joomla versions that support automatic updates (and thus mark as compatible with all future unreleased versions of Joomla in Joomla Update) add <code><targetplatform name="joomla" version=".*"/></code>. If you want your extension to show on all {{JVer\|3.x}} versions then rather than specifying a version in the version tag add in <code><targetplatform name="joomla" version="3.[012345]"/></code>. This will show the update to all 3.x versions from version 3.0 to 3.5. If you want to include version 3.10 you can use an <code>\|</code> like this: <code><targetplatform name="joomla" version="3.[012345]\|10"/></code>. If you want to show the updates for all 3.8.x versions and all 3.10.x versions you can use <code><targetplatform name="joomla" version="3.(8\|10)"/></code></translate>
	<translate><!--T:46-->		<translate><!--T:46-->
	* '''php_minimum''' – Beginning with 3.2.2, a minimum supported PHP version can be supplied in the update stream. If the server does not meet the minimum, a message is displayed to the user advising that an update is available but cannot be installed due to unsupported requirements.</translate>		* '''php_minimum''' – Beginning with 3.2.2, a minimum supported PHP version can be supplied in the update stream. If the server does not meet the minimum, a message is displayed to the user advising that an update is available but cannot be installed due to unsupported requirements.</translate>

Zero24 at 23:54, 13 September 2019

2019-09-13T23:54:30Z

← Older revision		Revision as of 23:54, 13 September 2019
Line 164:		Line 164:
	* '''php_minimum''' – Beginning with 3.2.2, a minimum supported PHP version can be supplied in the update stream. If the server does not meet the minimum, a message is displayed to the user advising that an update is available but cannot be installed due to unsupported requirements.</translate>		* '''php_minimum''' – Beginning with 3.2.2, a minimum supported PHP version can be supplied in the update stream. If the server does not meet the minimum, a message is displayed to the user advising that an update is available but cannot be installed due to unsupported requirements.</translate>
	<translate><!--T:54-->		<translate><!--T:54-->
	* '''supported_databases''' – Beginning with 3.7, a minimum supported ~~Databases~~ + version can be supplied in the update stream. If the server does not meet the minimum, a message is displayed to the user advising that an update is available but cannot be installed due to unsupported requirements.</translate>		* '''supported_databases''' – Beginning with 3.7, a minimum supported databases + version check can be supplied in the update stream. When the server does not meet the minimum, a message is displayed to the user advising that an update is available but cannot be installed due to unsupported requirements. Note: [https://github.com/joomla/joomla-cms/pull/26079 As of 3.9.12] there is also a special case for mariadb so you can set a specific minimum version for that too now.</translate>
	<translate><!--T:55-->		<translate><!--T:55-->
	** An example could look like this:</translate> <code><supported_databases mysql="5.5.3" postgresql="9.2" mssql="10.50.1600.1" /></code>		** An example could look like this:</translate> <code><supported_databases mysql="5.5.3" mariadb="10.1" postgresql="9.2" mssql="10.50.1600.1" /></code>
	<translate>		<translate>
	<!--T:60-->		<!--T:60-->

Max123kl: double underscore __ canged to single one (T:48)

2019-06-27T11:16:09Z

double underscore __ canged to single one (T:48)

← Older revision		Revision as of 11:16, 27 June 2019
Line 175:		Line 175:

	<translate><!--T:48-->		<translate><!--T:48-->
	The values of '''element''', '''type''', '''client_id''' and '''folder''' should match those in the table #~~__extensions~~.</translate>		The values of '''element''', '''type''', '''client_id''' and '''folder''' should match those in the table #_extensions.</translate>

	<translate><!--T:49-->		<translate><!--T:49-->

Max123kl: double underscore __ canged to single one (T:52)

2019-06-27T07:33:25Z

double underscore __ canged to single one (T:52)

← Older revision		Revision as of 07:33, 27 June 2019
Line 187:		Line 187:
	* '''SQL update script is not executed during update.'''</translate>		* '''SQL update script is not executed during update.'''</translate>
	<translate><!--T:52-->		<translate><!--T:52-->
	:If the SQL update script (for example, in the folder <code>sql/updates/mysql</code>) does not get executed during the update process, it could be because there is no version number in the <code>#~~__schemas~~</code> table for this extension ''prior to the update''. This value is determined by the last script name in the SQL updates folder. If this value is blank, no SQL scripts will be executed during that update cycle. To make sure this value is set correctly, make sure you have a SQL script in this folder with its name as the version number (for example, 1.2.3.sql if the version is 1.2.3). The file can be empty or just have a SQL comment line. This should be done in the old version -- the one before the update. Alternatively, you can add this value to the <code>#~~__schemas~~</code> using a SQL query.</translate>		:If the SQL update script (for example, in the folder <code>sql/updates/mysql</code>) does not get executed during the update process, it could be because there is no version number in the <code>#_schemas</code> table for this extension ''prior to the update''. This value is determined by the last script name in the SQL updates folder. If this value is blank, no SQL scripts will be executed during that update cycle. To make sure this value is set correctly, make sure you have a SQL script in this folder with its name as the version number (for example, 1.2.3.sql if the version is 1.2.3). The file can be empty or just have a SQL comment line. This should be done in the old version — the one before the update. Alternatively, you can add this value to the <code>#_schemas</code> using a SQL query.</translate>

	<translate>		<translate>

	== Supporting Tools == <!--T:53-->		== Supporting Tools == <!--T:53-->
	</translate>		</translate>