Update Channels


Introduction

Update channels are a crucial part of your update server. They are the feeds that your products download to find out if a new version is available. Update channel feeds are provided in XML and JSON formats, so you can use the format that suits your product best (e.g. Joomla uses the XML format, WordPress uses the JSON format, other web-based applications can use both formats). If your application requires other update channel feed format (e.g. INI, YAML), let us know and we'll consider adding support for your required format too.

{warning} Only info about your latest product version is provided in the update channel feeds. Older product versions are excluded.

Update channel types

UpdaterCloud has built in support for the following platforms and product types:

The difference between a package and a collection is that for a package, the URLs to individual product update channels are included in the feed (and then each URL needs to be accessed to download the product update details), while for a collection, the product update details are directly included in the feed. Joomla and WordPress don't use collections, so this feature can only be usedful to save requests and speed up updates for other than Joomla and WordPress web-based applications.

Create update channel

Update channels can be created by using the New button in the top toolbar, or by duplicating an existing update channel using the Duplicate button next to the update channel you want to duplicate from the update channels list. The new update channel details will be automatically filled in with the duplicated update channel details.

Edit update channel

You can edit the update channel by clicking on the Edit button next to the update channel you want to edit from the update channels list.

Update channel details

When creating a new update channel, or editing an existing one, the following fields are available:

Field Required Description
Name Yes Your update channel name, e.g. My Plugin Updates. The channel name must be unique.
Type Yes Select one of the available update channel types, depending on your product platform. The specific update channel type fields will be displayed below.
Minimum maturity Yes Minimum maturity of a release to be included in this update channel. E.g. if Beta is selected, then only Beta, RC and Stable versions will be included in this update channel. Dev and Alpha releases will be ignored.
Publishing status Yes When published, the update channel will be available for use in your products.

WordPress Plugin

When selecting the WordPress Plugin update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Slug Yes This is the slug of the plugin that will be updated, e.g. example-plugin.
File name pattern Yes Your release can have many files attached, e.g. the plugin installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the plugin installer zip file), e.g. example-plugin-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file example-plugin-1.0.0.zip
Minimum WordPress version Yes The lowest version of WordPress that the plugin will work on, e.g. 5.0
Highest WordPress version No The highest version of WordPress that the plugin will work or was tested on, e.g. 5.3.2
Upgrade notice No A short description of why the user should upgrade.
Small banner No This must be an url that points to a 772x250 pixels product image.
Large banner No This must be an url that points to a 1544x500 pixels product image that will be used on high-DPI screens.
Small Icon No This must be an url that points to a 128x128 pixels product icon.
Large icon No This must be an url that points to a 256x256 pixels product icon that will be used on high-DPI screens.
SVG icon No This must be an url that points to a SVG product icon.

WordPress Theme

When selecting the WordPress Theme update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Slug Yes This is the slug of the theme that will be updated, e.g. example-theme.
File name pattern Yes Your release can have many files attached, e.g. the theme installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the theme installer zip file), e.g. example-theme-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file example-theme-1.0.0.zip

Joomla Component

When selecting the Joomla Component update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Element Yes This is the component that will be updated, e.g. com_example.
File name pattern Yes Your release can have many files attached, e.g. the component installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the component installer zip file), e.g. com_example-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file com_example-1.0.0.zip
Minimum Joomla version Yes This is the minimum Joomla version that the component requires, e.g. 3.x (to show the update on all Joomla 3 versions), or 3.[012345] (to show the update only on Joomla 3.0 to 3.5), or .* (to show the update on all Joomla versions that support automatic updates).
Minimum PHP version No This is the minimum PHP version that the component requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MySQL version No This is the minimum MySQL version that the component requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum PostgreSQL version No This is the minimum PostgreSQL version that the component requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MSSQL version No This is the minimum MSSQL version that the component requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
JED extension id No This is used by Joomla's install from web feature. If your component is listed on JED, you should enter the JED extension id.

Joomla Module

When selecting the Joomla Module update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Element Yes This is the module that will be updated, e.g. mod_example.
Client Yes Select if this component is installed in the administrator or the frontend area of your site.
File name pattern Yes Your release can have many files attached, e.g. the module installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the module installer zip file), e.g. mod_example-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file mod_example-1.0.0.zip
Minimum Joomla version Yes This is the minimum Joomla version that the module requires, e.g. 3.x (to show the update on all Joomla 3 versions), or 3.[012345] (to show the update only on Joomla 3.0 to 3.5), or .* (to show the update on all Joomla versions that support automatic updates).
Minimum PHP version No This is the minimum PHP version that the module requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MySQL version No This is the minimum MySQL version that the module requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum PostgreSQL version No This is the minimum PostgreSQL version that the module requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MSSQL version No This is the minimum MSSQL version that the module requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
JED extension id No This is used by Joomla's install from web feature. If your module is listed on JED, you should enter the JED extension id.

Joomla Plugin

When selecting the Joomla Plugin update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Element Yes This is the plugin that will be updated, e.g. example.
File name pattern Yes Your release can have many files attached, e.g. the plugin installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the installer zip file), e.g. plg_example-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file plg_example-1.0.0.zip
Folder Yes The type of plugin being updated, e.g. content, system, etc.
Minimum Joomla version Yes This is the minimum Joomla version that the plugin requires, e.g. 3.x (to show the update on all Joomla 3 versions), or 3.[012345] (to show the update only on Joomla 3.0 to 3.5), or .* (to show the update on all Joomla versions that support automatic updates).
Minimum PHP version No This is the minimum PHP version that the plugin requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MySQL version No This is the minimum MySQL version that the plugin requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum PostgreSQL version No This is the minimum PostgreSQL version that the plugin requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MSSQL version No This is the minimum MSSQL version that the plugin requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
JED extension id No This is used by Joomla's install from web feature. If your plugin is listed on JED, you should enter the JED extension id.

Joomla Template

When selecting the Joomla Template update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Element Yes This is the template that will be updated, e.g. example_template.
Client Yes Select if this component is installed in the administrator or the frontend area of your site.
File name pattern Yes Your release can have many files attached, e.g. the template installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the template installer zip file), e.g. example_template-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file example_template-1.0.0.zip
Minimum Joomla version Yes This is the minimum Joomla version that the template requires, e.g. 3.x (to show the update on all Joomla 3 versions), or 3.[012345] (to show the update only on Joomla 3.0 to 3.5), or .* (to show the update on all Joomla versions that support automatic updates).
Minimum PHP version No This is the minimum PHP version that the template requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MySQL version No This is the minimum MySQL version that the template requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum PostgreSQL version No This is the minimum PostgreSQL version that the template requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MSSQL version No This is the minimum MSSQL version that the template requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
JED extension id No This is used by Joomla's install from web feature. If your template is listed on JED, you should enter the JED extension id.

Joomla Package

When selecting the Joomla Package update channel type, the following fields are available:

Field Required Description
Update channels Yes Select the update channels you want to include in this package. If you haven't yet created individual update channels for each product you want to include, first create the individual update channels, then come back to this page to build your package update channel.
Description No The update channel short description.

Joomla File

When selecting the Joomla Template update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Element Yes This is the element that will be updated, e.g. joomla.
File name pattern Yes Your release can have many files attached, e.g. the Joomla installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the Joomla installer zip file), e.g. joomla-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file joomla-1.0.0.zip
Section Yes LTS, STS or Testing.
Minimum PHP version No This is the minimum PHP version that Joomla requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MySQL version No This is the minimum MySQL version that Joomla requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum PostgreSQL version No This is the minimum PostgreSQL version that Joomla requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MSSQL version No This is the minimum MSSQL version that Joomla requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.

Joomla Library

When selecting the Joomla Library update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Element Yes This is the library that will be updated, e.g. example_library.
File name pattern Yes Your release can have many files attached, e.g. the library installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the library installer zip file), e.g. example_library-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file example_library-1.0.0.zip
Minimum Joomla version Yes This is the minimum Joomla version that the library requires, e.g. 3.x (to show the update on all Joomla 3 versions), or 3.[012345] (to show the update only on Joomla 3.0 to 3.5), or .* (to show the update on all Joomla versions that support automatic updates).
Minimum PHP version No This is the minimum PHP version that the library requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MySQL version No This is the minimum MySQL version that the library requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum PostgreSQL version No This is the minimum PostgreSQL version that the library requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.
Minimum MSSQL version No This is the minimum MSSQL version that the library requires. If the client server doesn`t meet the minimum, Joomla will display a message to the user advising that an update is available but cannot be installed due to unsupported requirements.

JED Extension

When selecting the JED extension update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Description Yes The product description as you want it to be displayed on JED. Allows markdown text.
Download URL Yes The URL where the product can be downloaded from.
Demo URL No The product demo URL.
Documentation URL Yes The URL where the product documentation can be found at.
Support URL Yes The URL to your forum, knowledgebase or support tickets system.
License URL Yes The URL to where your product license/terms.
Minimum Joomla version Yes This is the minimum Joomla version that this extension requires, e.g. 3.x (to show the update on all Joomla 3 versions), or 3.[012345] (to show the update only on Joomla 3.0 to 3.5), or .* (to show the update on all Joomla versions that support automatic updates).

Generic Item

When selecting the Generic Item update channel type, the following fields are available:

Field Required Description
Product Yes The product for which this update channel is for.
Info URL No The url where product details can be found at.
Slug Yes This is the slug of the item that will be updated, e.g. example-item.
File name pattern Yes Your release can have many files attached, e.g. the item installer zip file, a documentation PDF, etc. Here you can set the file name pattern for the file to be provided in update channels (usually the item installer zip file), e.g. example-item-*.zip, where the wildcard will be automatically replaced with the version number, e.g. if you've named your zip file example-item-1.0.0.zip

Generic Package

When selecting the Generic Package update channel type, the following fields are available:

Field Required Description
Update channels Yes Select the update channels you want to include in this package. If you haven't yet created individual update channels for each product you want to include, first create the individual update channels, then come back to this page to build your package update channel.
Description No The update channel short description.

Generic Collection

When selecting the Generic Collection update channel type, the following fields are available:

Field Required Description
Update channels Yes Select the update channels you want to include in this collection. If you haven't yet created individual update channels for each product you want to include, first create the individual update channels, then come back to this page to build your collection update channel.
Description No The update channel short description.

Filter update channels

Update channels can be filtered from the files list, by clicking on the Filter button in the top toolbar.

Delete update channel

Update channels can be deleted from the update channels list, by clicking on the Delete link next to the update channel you want to delete, or from the update chanel editing page. If there are any products still using this update channel, the product updates will stop working and the update channel will return a 404 Not Found response.

{danger} Deleted items are not recoverable. This action is permanent and can't be undone.