Installing Magento Extensions : Easy Install Guide

From Moogento How-to Guides
(Redirected from Easy Install Guide)
Jump to: navigation, search

Aims & Preparation

Make sure you've gone through the Pre-install Checklist before starting!

Upgrading from an older version? Check our Upgrading Extensions Guide



---- Magento 1 ----

1. Upload The Files

  1. Unzip your extension package.
  2. Inside that package you'll see Step_1, open that folder inside your FTP app.
  3. Locate your website's Magento app folder in the same app. You should now have the contents of Step_1 on one side, and your main website folder (containing the Magento app folder) on the other side. Check that you see an app folder each side.ftp install magento extensions.png
  4. Drag the folders from inside Step_1 into your remote site (the important thing here is not to drag on top of another folder, or the files will be placed in the wrong location - easiest is to drag onto a file or blank space on the remote side).magento install drag n drop.png
  5. You may be asked Merge or Replace? by your FTP app. Choose Merge for folders and Replace for files.merge folders replace files.png
  6. When that has completed, open Step_2 in your unzipped extension folder.
  7. Using the same procedure, copy the contents of Step_2 into the same location in your Magento installation.ftp install magento extensions step2.png
  8. If you're using a 3rd party admin theme, you may need to also copy the contents of skin/adminhtml/default/default folder into both skin/adminhtml/default/[skin name] and skin/adminhtml/go
  9. If you're installing pickPack and are going to be attaching fonts to your PDFs (eg. custom fonts or non-Roman characters), then, also using the same procedure, copy the contents of Step_Optional_Font_Pack into the same location in your Magento installation.

2. Clear the Cache and Assign User Permissions

  1. Go to the SystemCache settings, and clear all caches (click Flush Magento Cache and Flush Cache Storage).
    Do this even if you have caching generally disabled.
  2. Log out then Log in.
    This will allow you to edit the config page for this extension (and avoid the 404 error).
  3. Head to SystemPermissionsRoles
  4. Check that you have assigned the new Moogento Extension options to the appropriate roles, and save.
    • If saving an admin role, likely you have 'All' resources set; just re-save this:
    magento-full-user-access-role.png
    • If saving a partial access role (eg. granting pickers access to create Packing Sheets), find the new extension sections and grant as needed (eg. here is access to mass-action menu options):
    action-menu-role.png
    • Don't forget to set the access to the System>Configuration section if you need to:
    system-config-role.png
  5. Head to SystemPermissionsUsers
  6. Check that you have assigned the correct role (that we just granted the appropriate Extension options to) to the appropriate users, and save.
    user-access-choice.png


3. Enter the License Key

If you're installing a Moogento extension, we'll have sent you a license key. Let's install it!

  1. Navigate to SystemConfiguration and then to the specific config page for your new Extension.
  2. At the top, if this extension requires a license key, enter your license key (this will have been emailed to you; you can also find it inside your Moogento account downloads section).
    • Click the 'License' word to expand that section if it's not already showing the key entry field.
    • Enter the key and save the page:
    entering-magento-license-key.png


4. Save the Config Page

After entering the license key, save the config page.

  • Even if you're installing an extension without a license key, it's still a good idea to save the config section at this point (even if you've not made any changes).
(It's possible to generate some errors if running some extensions without values saved to the config).
  • Clear the Magento cache, and then the browser cache.

If you're not sure about browser cache, what usually works is holding the shift button and clicking refresh.


---- Magento 2 ----

1. Upload The Files

  1. Unzip your downloaded zip and open the single folder (usually the extension name).
  2. Inside that you'll see app and m2.0.patches. Open this containing folder inside your FTP app.
  3. Locate your website's Magento app folder in the same FTP app. You should now have the unzipped app on one side, and your main website folder (containing the Magento app folder) on the other side.
    * Check that you see an app folder each side.magento-2-plugin-installation.png
  4. Drag the app folder from inside the unzipped folder into your remote site (the important thing here is not to drag on top of another folder, or the files will be placed in the wrong location - easiest is to drag onto a file or blank space on the remote side).drag-n-drop-copy-app-folder.png
  5. You may be asked Merge or Replace? by your FTP app. Choose Merge for folders and Replace for files.merge folders replace files.png
  6. Only if you're using a version of Magento 2 that's less than 2.1, copy m2.0.patches into your remote root folder, overwriting any file changes.
  7. If you're installing pickPack and are going to be attaching fonts to your PDFs (eg. custom fonts or non-Roman characters), then, also using the same procedure, copy the contents of Step_Optional_Font_Pack into the same location in your Magento installation.
    * Get the extra font zipped folder from inside your account Downloads folder.

2. Disable the Cache

Disable the cache in SystemCache Management

3. Run Setup Scripts

  • Run this on the command line (when logged-in to the remote server):

php ­f bin/magento setup:upgrade

  • then we're going to upgrade the database, with any new tables needed by the plugin:

php ­f bin/magento setup:db­schema:upgrade

4. Check Installation

Head to StoresConfigurationAdvanced -> Advanced and you should see your new module in the admin panel.

moogento-installed-magento-2.png

5. Clear Cache and Set User Permissions

  1. Go to the SystemCache settings, and clear all caches (click Flush Magento Cache and Flush Cache Storage).
    Do this even if you have caching generally disabled.
  2. Log out then Log in.
  3. Head to SystemPermissionsUser Roles
    magento-2-user-roles.png
  4. Check that you have assigned the new Moogento Extension options to the appropriate roles, and save.
    • If saving an admin role, likely you have 'All' resources set; just re-save this:
    magento-2-user-all-role-access.png
    • If saving a partial access role (eg. granting pickers access to create Packing Sheets), find the new extension sections and grant as needed (eg. here is access to edit the PDF templates):
    magento-config-settings-pickpack.png
  5. Head to SystemPermissionsUsers
  6. Check that you have assigned the correct role (that we just granted the appropriate Extension options to) to the appropriate users, and save.

6. Enter The License Key

If you're installing a Moogento extension, we'll have sent you a license key. Let's install it!

  1. Navigate to MoogentoLicense.
  2. At the top, if this extension requires a license key, enter your license key (this will have been emailed to you; you can also find it inside your Moogento account downloads section).
    • Enter the key and save the page. You should see a green tick!
    moogento-license-entry.png


7. Save The Config Page

After entering the license key, clear the cache and logout again.

  • Even if you're installing an extension without a license key, it's still a good idea to save the config section at this point (even if you've not made any changes).


---- Magento 1 & 2 ----

Registering Your License For Dev/Staging Sites

If you're setting up on a dev or staging server, we've got you covered. You can assign up to 2 dev/staging servers to each key, and we have a super-simple way to assign them.

  1. Navigate to your Moogento Account downloads section.
  2. Find the specific extension you want to request dev/staging access for.
  3. Click '+ dev domain'
  4. Enter the domain name.
  5. Click 'Request'
  6. Done! We'll check that and assign it within 1 working day.
    dev-licenses.png
  • Enter the license key in every install you make with our software, including dev & staging sites.
  • Before installing the software, please add the domain you'll be using to the list of authorised domains, as described above.
It's against the terms of your license to use the software:
- without entering the license key in every install
- without authorising the domain before use
(only needed if you're using multiple domains for testing - the first-used domain is registered automatically)
- on multiple Magento installations
(excepted : dev/staging sites for the specific domain the key is purchased for)

Quick Check Extension Is Installed Ok

  1. Check that it works at a basic level; this is also a good time to check your public store front. I would also make a test order at this stage, check that the emails you're expecting are coming through etc.
  2. If everything is ok and you have previously disabled compilation, now you can enable it.

You should now be setup at a basic level.

If you have any issues, check the Troubleshooting guide.