Difference between revisions of "Install From Web (For Developers)"
From Joomla! Documentation
m (→1. Fill out the 2 new fields on JED: Extra line space) |
(Adding more detailed cases) |
||
| Line 6: | Line 6: | ||
If you edit your extension listing on JED you will see the following new fields. Select the type of your extension from the list - there are four options: | If you edit your extension listing on JED you will see the following new fields. Select the type of your extension from the list - there are four options: | ||
# None | # None | ||
| − | # Free Direct Download Link | + | # Free Direct Download Link: |
| − | # Free but Registration Required at Link | + | # Free but Registration Required at Link: |
| − | # Commerical Purchase Required at Link | + | # Commerical Purchase Required at Link: |
| − | + | And, '''Download/registration/purchase URL''' field. URL can target: | |
| − | + | # A zip URL E.g. http://www.example.com/updates/com_extension_v9.9.zip | |
| + | # A update XML URL E.g. http://www.example.com/updates/extension_update.xml | ||
| − | + | If your extension is a free direct download link then all your work is done and you can ignore the next step :) | |
| + | |||
| + | == None == | ||
| + | |||
| + | This the most common case today. Only JED mandatory fields are filled, and 'Install From Web' fields are empty. The entry is shown, 'Download' button is shown and there's no 'Install' button. | ||
| + | |||
| + | If your extension is just a '''free direct download link''' - then put in a link to the update XML you have or direct URL to the zip file. | ||
| + | |||
| + | == Free Direct Download Link == | ||
| + | |||
| + | If the URL field is filled with a zip or an update XML URL; 'Install' button appears, and the user can just click to install. | ||
| − | If your extension | + | == Free but Registration Required at Link == |
| + | |||
| + | If your extension requires registration then you need to put a link to your site '''Registration Page'''; 'Install' button appears, and the user can just click to be redirected to your site. | ||
| + | |||
| + | == Commerical Purchase Required at Link == | ||
| + | |||
| + | If your extension requires a payment then you need to put a link to your site '''Purchase Page'''; 'Install' button appears, and the user can just click to be redirected to your site. | ||
==2a. Setting your site and extensions up for a Free but Registration Required Extension== | ==2a. Setting your site and extensions up for a Free but Registration Required Extension== | ||
Revision as of 11:47, 8 November 2013
introduced the new Install from web feature that allows direct installations of extensions that are listed on JED. Making your extensions that are already on JED is a two step process:
1. Fill out the 2 new fields on JED[edit]
If you edit your extension listing on JED you will see the following new fields. Select the type of your extension from the list - there are four options:
- None
- Free Direct Download Link:
- Free but Registration Required at Link:
- Commerical Purchase Required at Link:
And, Download/registration/purchase URL field. URL can target:
- A zip URL E.g. http://www.example.com/updates/com_extension_v9.9.zip
- A update XML URL E.g. http://www.example.com/updates/extension_update.xml
If your extension is a free direct download link then all your work is done and you can ignore the next step :)
None[edit]
This the most common case today. Only JED mandatory fields are filled, and 'Install From Web' fields are empty. The entry is shown, 'Download' button is shown and there's no 'Install' button.
If your extension is just a free direct download link - then put in a link to the update XML you have or direct URL to the zip file.
Free Direct Download Link[edit]
If the URL field is filled with a zip or an update XML URL; 'Install' button appears, and the user can just click to install.
Free but Registration Required at Link[edit]
If your extension requires registration then you need to put a link to your site Registration Page; 'Install' button appears, and the user can just click to be redirected to your site.
Commerical Purchase Required at Link[edit]
If your extension requires a payment then you need to put a link to your site Purchase Page; 'Install' button appears, and the user can just click to be redirected to your site.
2a. Setting your site and extensions up for a Free but Registration Required Extension[edit]
If you require a consumer to register or be using a commercial extension then you have to set up a plugin on your site to deal with the user registration. A good starting point is a plugin that was developed specifically for this purpose found here.
This plugin is specifically designed for the Joomla User Component however it will also integrate nicely with Community Builder simply by changing the entry point URL in the plugins parameters - generally it is recommended (but my no means compulsory) to point this to your login page. Note an empty value of this parameter will default to pointing to the Joomla User Component Login page.
The final parameter you have to set up is to point the plugin to your extensions update XML file or zip file. This is done in the Files to Download parameter
On each line put the JED number of your extension followed by the link to the extension for example:
30458=>http://www.example.com/updates/extension_update.xml
2b. Setting your site and extensions up for a Commercial Extension[edit]
This will need more work than the previous step. It is advised that you download the same plugin - however you will have to integrate into the plugin an extra check to see if the user has purchased your extension. As different extensions implement this in many different ways it is left to extension developers to implement this functionality.