Dieser Inhalt ist auch auf Deutsch verfügbar.

Install Magento Extension

Don't want to do the installation yourself? Just book my support.

The following is a quick installation guide for my Magento Extensions, using the Advanced Invoice Layout Extension as an example.

Preparations

  • For security reasons, we recommend creating a backup of your Magento installation (database and files)
  • Magento 1 only: disable the Magento Compiler feature under System › Tools › Compiler (if enabled)
  • Uninstall any previous versions of the module
  • For installation with composer, please make sure composer is installed on your system. For details, see the composer installation guide.

Installation with composer

Of course, you can also install my proprietary Magento Extensions via the awesome composer tool. This applies to both my Magento 1 and Magento 2 extensions.

To do this, please perform the following steps:

  • Contact me to get the access keys. You will receive the composer repository URL, a username and password.
  • Paste the following entry into your composer.json file:
    "repositories": [{
        }, "type": "composer",
        "url": "https://packages.vianetz.com/.."
    }]
    
  • In your Magento installation directory, please run the
    composer require vianetz/module-advancedinvoicelayout
    command and then enter the credentials that were provided to you.

After that, all dependencies will be installed automatically and you can follow the rest of the steps in the installation instructions.

Note: the credentials can be stored in a auth.json file, so you don't have to enter them every time.

Instruction for Magento 2

The guide for Magento 1 is below.

  1. Create a new directory for the extension in app/code/, e.g. app/code/Vianetz/AdvancedInvoiceLayout.
  2. Unzip the setup package and copy the contents into the newly created folder. The folder structure should now look like this:app/code/Vianetz/AdvancedInvoiceLayout/Block, app/code/Vianetz/AdvancedInvoiceLayout/etc, etc.

    Please make sure that the files are created with the same permissions as the user of the Magento installation!

  3. Install the Extension requirements via composer on the command line e.g. via SSH with the following command in your Magento installation directory:
    composer require --update-no-dev vianetz/pdf-generator:^3.0 vianetz/module-core:^1.0

    Note: If you are using an older PHP version on the command line than for your web server, you can add this to the --ignore-platform-reqs parameter to ignore the PHP version checks.

  4. Activate the extension and run the setup process by executing the following commands:
    bin/magento module:enable Vianetz_Core Vianetz_AdvancedInvoiceLayout &&
    bin/magento setup:upgrade
  5. Run the compilation (only needed in Magento Production Mode):
    bin/magento setup:di:compile
  6. Clear the Magento cache (e.g. System › Cache Management) and all associated caches if in use (e.g. APC, Varnish, ..).
  7. Congratulations, the installation is completed successfully!

Instruction for Magento 1

Installation

  1. Unzip the (zip) setup package and copy the contents of the src/ directory to the main Magento installation directory. (The directory structure is the same as in your Magento installation (app/, skin/, ..); no files will be overwritten.).
    Please make sure the files have the same permissions as the rest of the Magento installation files!
  2. Clear the Magento cache (e.g. System › Cache Management) and if necessary any other caches (e.g. APC, Varnish, ..).
  3. Log out of the Magento administration area and log back in.

Congratulations, the installation is completed successfully!

Frequently asked questions about Magento installation

How can I install the Magento extensions via composer?
See here.

On this page, I've also summarized some common problems in Magento.