# Installation for Joomla!

Installing XT Search for Algolia (opens new window) is no different than installing any other Joomla!™ extension on your site. You can read the complete instructions for installing Joomla!™ extensions on the official help page (opens new window). Throughout this chapter, we assume that you are familiar with these instructions and we will try not to duplicate them.

# Installation Services

Save your time and focus on your business

Besides the general configuration, we complete the process according to the search configuration, in particular:

  • Check Configuration of Instant Auto-complete and search.
  • Check Adaptation and styling of the Instant Auto-complete and search to the store template.
  • Check Unlimited number of indexes, languages and products included.
  • Check Average project duration: 7-10 work days.

To know more about the installation services, click here: https://www.extly.com/xt-search-for-algolia.html#Installation-Service (opens new window)

# Basic installation

Just like with most Joomla! extensions there are three ways to install or manually update XT Search for Algolia on your site:

  • Install from URL It is the easiest and fastest one, if your server supports it. Most servers do support this method.
  • Upload and Install. That's the typical extension installation method for Joomla! extensions. It rarely fails.
  • Manual installation. This is the hardest, but virtually fail-safe, installation method.

Please note that installing and updating XT Search for Algolia (and almost all Joomla! extensions) is actually the same thing. If you want to update XT Search for Algolia please remember that you MUST NOT uninstall it before installing the new version! When you uninstall XT Search for Algolia you will lose all your settings. This is definitely something you do not want to happen! Instead, simply install the new version on top of the old one. Joomla! will figure out that you are doing an update and will treat it as such, automatically.

TIP

If you find that after installing or updating XT Search for Algolia it is missing some features or doesn't work, please try installing the same version a second time, without uninstalling the component. The reason is that very few times the Joomla! extensions installer infrastructure gets confused and fails to copy some files or entire folders. By repeating the installation you force it to copy the missing files and folders, solving the problem.

# Install from URL

The easiest way to install XT Search for Algolia is using the Install from URL feature in Joomla!.

TIP

This Joomla! feature requires that your server supports fopen() URL wrappers (allow_url_fopen is set to 1 in your server's php.ini file) or has the PHP cURL extension enabled. Moreover, if your server has a firewall, it has to allow TCP connections over ports 80 and 443 to www.extly.com and cdn.extly.com. If you don't see any updates or if they fail to download please ask your host to check that these conditions are met. If they are met but you still do not see the updates please file a bug report in the official Joomla! forum (opens new window). In the meantime, you can use the manual update methods discussed further below this page.

First, go to our site's download page (opens new window) for XT Search for Algolia. Make sure you are logged in. If not, login now. These instructions won't work if you are not logged in! Click on the version you want to install. Please note that the latest released version is always listed first on the page. On that page, you will find XT Search for Algolia. Next to the Download Now button you will see the DirectLink link. Right click on it and select Copy link address or whatever your browser calls this.

Now go to your site's administrator page and click on Extensions, Extension Manager. If you have Joomla! 3.x click on the Install from URL tab. Clear the contents of the Install URL field and paste the URL you copied from our site's download page. Then click on the Install button. Joomla! will download and install the XT Search for Algolia update.

# Upload and Install

  1. You can download the latest installation packages from our site's download page (opens new window) for XT Search for Algolia. Please note that the latest version is always on top. Click on the version you want to download and install.
  2. Click on the XT Search for Algolia item to download the ZIP installation package.
  3. All XT Search for Algolia installation packages contain the component and all of its associated extensions. Installing it will install all of these items automatically. It can also be used to upgrade XT Search for Algolia; just install it without uninstalling the previous release.
  4. Log in to your site's administrator section. Click on Extensions, Manage link on the top menu. If you are on Joomla! 3.x please click on the Upload Package File tab. Locate the Browse button next to the Package File or Extension package file field. Locate the installation ZIP file you had previously downloaded and selected it. Back to the page, click on the Upload & Install button. After a short while, Joomla!™ will tell you that the component has been installed.

# Manual installation

  1. You can download the latest installation packages our site's download page (opens new window) for XT Search for Algolia. Please note that the latest version is always on top. Click on the version you want to download and install.
  2. Click on the XT Search for Algolia item to download the ZIP installation package.
  3. All XT Search for Algolia installation packages contain the component and all of its associated extensions. Installing it will install all of these items automatically. It can also be used to upgrade XT Search for Algolia; just install it without uninstalling the previous release.
  4. Before doing anything else, you have to extract the installation ZIP file in a subdirectory named XT Search for Algolia on your local PC. Then, upload the entire subdirectory inside your site's temporary directory. At this point, there should be a subdirectory named XT Search for Algolia inside your site's temporary directory which contains all of the ZIP package's files.
  5. If you are unsure where your site's temporary directory is located, you can look it up by going to the Global Configuration, click on the Server tab and take a look at the Path to Temp-folder setting. The default setting is the tmp directory under your site's root. Rarely, especially on automated installations using Fantastico, this might have been assigned the system-wide /tmp directory. In this case, please consult your host for instructions on how to upload files inside this directory, or about changing your Joomla!™ temporary directory back to the default location and making it writable.
  6. Assuming that you are past this uploading step, click on Extensions, Manage link on the top menu. If you are on Joomla! 3.x please click on the Install from Directory tab. Locate the Install Directory edit box. It is already filled in with the absolute path to your temporary directory, for example /var/www/joomla/tmp. Please append /the-extension to it. In our example, it should look something like /var/www/joomla/tmp/the-extension. Then, click on the Install button.

TIP

If you still can't install XT Search for Algolia and you are receiving messages regarding unwritable directories, inability to move files, or other similar file system related error messages, please consult our installation troubleshooting instructions. If these instructions do not help please do not request support from us; we are unlikely to be able to help you. These errors come from your site set up and can best be resolved by asking your host for assistance or by asking other users in the official Joomla!™ forums.

# Updates

# Checking for the latest version and upgrading

You can check for the latest published version by visiting site's download page (opens new window) for XT Search for Algolia. The page lists the version and release date of the latest XT Search for Algolia release. If your release is out of date, simply click on the Download link to download the install package of the latest release to your PC.

# Updating manually

As noted in the installation section, installing and updating XT Search for Algolia is actually the same thing. If the automatic update using Joomla!'s extensions update feature does not work, please install the update manually following the instructions in the installation section of this documentation.

TIP

When installing an update manually you MUST NOT uninstall your existing version of XT Search for Algolia. Uninstalling XT Search for Algolia will always remove all your settings. You definitely not want that to happen!

# Uninstallation

You can uninstall the component just like any other Joomla! component. In your site's back-end, just go to Extensions Manager, click on Uninstall, select XT Search for Algolia and click on Uninstall. This will completely remove XT Search for Algolia including all plugins, modules and ticket information.

# Initial Configuration

Initial Configuration

Once you install the extension for the first time, please, visit the Control Panel. At this point, the first step is configuring the Live Update and the general settings.

# Live Update

XT Search for Algolia needs you to set up the Download ID (opens new window) before you can install the updates. You can find your main Download ID (opens new window), in your Account/Your Download ID (opens new window) area. Then go to your site's administrator page and click on Components, XT Search for Algolia, and click on the Options button in the toolbar. Click on the Live Update tab and paste your Download ID there. Finally, click on Save & Close.

Live Update

Last Updated: 3/20/2024, 3:32:54 PM