Manage your free or premium products on UpdaterCloud


Introduction

Products are the top-level of the release system and they represent your actual WordPress plugins and themes, Joomla extensions (components, modules, plugins, templates, libraries, even the joomla package itself, if you're using a custom Joomla build that you need to update from a custom source), or other web-based applications you may want to provide updates for.

Create product

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

Edit product

You can edit the product by clicking on the Edit button next to the product you want to edit from the products list.

Product details

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

Basic product details

Field Required Description
Group Yes Select the group this product is part of. If you're not using the Groups feature, select the default group.
Name Yes This is the product name and must be unique.
Short description No The product short description/tagline.
Type Yes The product can be free or commercial/paid. Select commecrial if this product requires a valid download key to be updated.
Description No The product description can contain markdown text.
Publishing status Yes When published, the product will be available to be used, for example to assign versions to it.

Git releases integration

Whenever a new release is created on your Git repository, a new release can be created automatically on your update server too, so your users can update instantly. To enable this integration, you have to create a webhook in your Git product respository using the URL and secret signing key generated when creating the product on your update server. The following fields must be filled:

Field Required Description
Git provider Yes Select the Git provider to use: GitHub, GitLab (coming soon) or Bitbucket (coming soon). You also need to set your Git provider personal access token in Settings. The personal access token must have the "repo" scope.
Owner Yes This is your repository owner (username), e.g. myusername
Repository Yes This is your repository name, e.g. my-product-repository
Branches Yes UpdaterCloud releases will be created only for Git releases made on these branches. You have to make sure the release tags will be unique for all branches (for example, use -dev in version tag for releases made on the dev branch). Separate the branches by comma and don`t use any spaces, e.g. master,dev
Webhook URL Yes Create a webhook in your Git repository settings and use this webhook payload url. The webhook URL will be generated after saving the product details. If you've made changes to the Git provider settings (when editing the product), the webhook url will be updated after saving the product details.
Webhook signing key Yes To make sure the webhook payload hasn't been tampered with, it must be signed using this secret signing key.

{warning} If your product repository is private, you must set the GitHub personal access token in Settings.

Once you've saved your product details, you'll get the webhook url and secret signing key to be used when creating the webhook on your product's git repository settings.

In your GitHub product repository settings, create a webhook with the following details:

  • Payload URL: This is the webhook url generated for your product
  • Content type: application/json
  • Secret: The webhook secret signing key generated for this product.
  • Which events would you like to trigger this webhook?: Select Let me select individual events, uncheck all boxes and only check the Releases box.

Once done, click save and a webhook test call will be made to the provided webhook url. If successfull, a green check mark will show up next to the webhook delivery id.

{warning} When a Git release is created/updated, if the release version (tag) already exists on your update server, the release details and files will be updated/synced with the Git release details and files (assets). When a Git release is deleted, it will be deleted from your update server too.

Other product details

Field Required Description
License No The product license name, e.g. GPL, MIT, etc.
License URL No The URL where the license is available.
Author name No The product author name (your or your company name).
Author URL No The URL where the product description is available on your website.

{info} If you need extra product details fields, please let us know and we'll consider adding them.

Download key validator

Field Required Description
Download key validator Yes Select one of the available download key validators to be used for validating licenses for this product. Only one download key validator can be used at a time.
Download keys require activation? Yes Enable this option only if you're using the UpdaterCloud download key validator and you've implemented the download key activation feature in your product.

{info} If you're using other service to sell your products and issue licenses, please let us know and we'll consider adding support for it too.

Envato purchase code validator

Field Required Description
Envato product id Yes Your product id on Envato. You also need to set your Envato personal access token in Settings. The access token must have the "View the user's items sales history" permission.

{info} The Envato product details are only required when using the Envato license key validator.

EDD license validator

Field Required Description
Website url Yes The website base url where EDD is installed, e.g. https://example.com.
EDD item id Yes Your item/product id on EDD.

{info} The Easy Digital Downloads (EDD) product details are only required when using the EDD license key validator.

Filter products

Products can be filtered from the products list, by clicking on the Filter button in the top toolbar.

Delete product

Products can be deleted from the products list, by clicking on the Delete link next to the product you want to delete, or from the product editing page. You won't be able to delete a product if it still has versions assigned.

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