Installing Magento Extensions

Installing Magento Extensions

Use the following steps to install or upgrade linksync extensions for Magento. The guide is written for a basic web server setup (one server with a Apache and Mysql). For more advanced setups please consult with your system administrator, website developers, or hosting company. 

  • Step 1 - Turn off Magento Compilation Mode
  • Step 2 - Turn on Magento Cache
  • Step 3 - Install the extension
  • Step 4 - Refresh Magento Cache
  • Step 5 - Log Out of Magento Admin and Log Back In
  • Step 6 - Re-run Magento Compilation Process
  • Troubleshooting
  • Related articles

 

We advise that you install any new extension on a test site before you add it to your live site. This enables you to test the extension and confirm it meets your needs before enabling it on your live site.  

Step 1 - Turn off Magento Compilation Mode

Check to see if Magento compilation mode has been enabled. If it has, it’s vital to turn it off before installing an extension or making any code changes at System > Tools > Compilation.

Not disabling compilation mode before installing an extension could make your site inaccessible (including the admin area).
 



Step 2 - Turn on Magento Cache

Turn on the Magento Configuration Cache to ensure any database updates associated with the extension are applied correctly.  

Step 3 - Install the extension

We advise against using Magento Connect to install linksync extensions as it can result in server permission issues and/or result in errors when attempting to upgrade a linksync extension in the future.

Download your linksync extension from the release notes page associated with the solution you're installing, and unzip the extension files into a separate folder on your PC/Mac. 

Next, upload the unzipped files to your Magento server using and FTP or SFTP client such as Filezilla. To do this: 

  1. Connect to the server
  2. Navigate to your Magento root folder
  3. Upload the previously unzipped files to your root folder by dragging them from your local computer to your Magento root folder

 

 The location of the Magento root folder depends on where you originally installed Magento, and is also driven by your webhosting company. Common folder locations to check include:

/ 
/public_html 
/www 
/var/www/ 
/home/YOURUSERNAME/www 
/home/YOURUSERNAME/public_html 
/srv/ 

You know you’ve found the right folder when you see the following subfolders:

app 
downloader 
errors 
includes 
media

If you can’t find the Magento root folder, get in touch with your hosting company and ask them to help you locate it. In most cases, it is the same as the document root.

Step 4 - Refresh Magento Cache

Refresh the Magento cache to register the new extension and run any installation routines. Do this by navigating to the Cache Management page and pressing the orange Flush Magento Cache button. 

Step 5 - Log Out of Magento Admin and Log Back In

Log out and then back into the backend of your Magento store to reload any access rules associated with the new extension. Failure to do so may result in an 'access denied' or '404 not found' error when trying to accessing settings pages for your new extension. 

Step 6 - Re-run Magento Compilation Process

If you disabled the Magento compilation mode at Step 1, you need to press the Run Compilation Process button at System > Tools > Compilation to update the compiled state with the newly installed extension.

Troubleshooting

I need to disable an extension

You can completely disable an extension by removing its xml file in the app/etc/modules folder.

The naming convention for this file is linksync_<extension>.xml. Change the filename ending to anything but xml. So for example to disable linksync eParcel you could rename the file app/etc/modules/Linksync_Linksynceparcel.xml to app/etc/modules/Linksync_Linksynceparcel.disable. Renaming this file instead of deleting it allows you to re-enable the extension again.

After renaming the file you need to refresh your Magento cache by deleting the contents of the var/cache folder.

Have more questions? Submit a request

Can't find what you're looking for?

We'd love to help. Contact us.