Aimeos TYPO3 extension

⭐ Star us on GitHub — it motivates us a lot!

Aimeos is THE professional, full-featured and high performance e-commerce extension for TYPO3! You can install it in your existing TYPO3 web site within 5 minutes and can adapt, extend, overwrite and customize anything to your needs.

Table of content

Installation
- TER
- Composer
TYPO3 setup
- Extension
- Database
Page setup
License
Links

Installation

This document is for the latest Aimeos TYPO3 20.10 release and later.

Stable release: 21.04 (TYPO3 9/10 LTS)
LTS release: 20.10 (TYPO3 9/10 LTS)

TYPO3 extension repository

If you want to install Aimeos into your existing TYPO3 installation, the Aimeos extension from the TER is recommended. You can download and install it directly from the Extension Manager of your TYPO3 instance.

For new TYPO3 installations, there's a 1-click Aimeos distribution available too. Choose the Aimeos distribution from the list of available distributions in the Extension Manager and you will get a completely set up shop system including demo data for a quick start.

Composer

Note: Currently, only composer 1.x can be used to install Aimeos for TYPO3 due a version conflict in the TYPO3 composer installer plugin!

The latest version can be installed via composer too. This is especially useful if you want to create new TYPO3 installations automatically or play with the latest code. You need to install the composer package first if it isn't already available:

php -r "readfile('https://getcomposer.org/installer');" | php -- --filename=composer

In order to tell install TYPO3, you have to execute

composer create-project typo3/cms-base-distribution myshop

This will install TYPO3 into the ''./myshop/'' directory. Afterwards, you have to edit the composer.json file and add the ''post-install-cmd'' and ''post-update-cmd'' scripts:

    "scripts": {
        "post-install-cmd": [
            "Aimeos\\Aimeos\\Custom\\Composer::install"
        ],
        "post-update-cmd": [
            "Aimeos\\Aimeos\\Custom\\Composer::install"
        ]
    }

Then, install the Aimeos extension for TYPO3 with:

composer req aimeos/aimeos-typo3:~21.4

This will install TYPO3 9.5 and the latest Aimeos TYPO3 extension. The Aimeos composer script will be executed automatically, which copies some required files and adds a link to the Aimeos extensions placed in the ./ext/ directory.

TYPO3 setup

Database setup

If you use MySQL < 5.7.8, you have to use utf8 and utf8_unicode_ci instead because those MySQL versions can't handle the long indexes created by utf8mb4 (up to four bytes per character) and you will get errors like

1071 Specified key was too long; max key length is 767 bytes

To avoid that, change your database settings in your ./typo3conf/LocalConfiguration.php to:

'DB' => [
    'Connections' => [
        'Default' => [
            'tableoptions' => [
                'charset' => 'utf8',
                'collate' => 'utf8_unicode_ci',
            ],
            // ...
        ],
    ],
],

Security

Since TYPO3 9.5.14+ implements SameSite cookie handling and restricts when browsers send cookies to your site. This is a problem when customers are redirected from external payment provider domain. Then, there's no session available on the confirmation page. To circumvent that problem, you need to set the configuration option cookieSameSite to none in your ./typo3conf/LocalConfiguration.php:

    'FE' => [
        'cookieSameSite' => 'none'
    ]

Extension

Log into the TYPO3 back end
Click on ''Admin Tools::Extension Manager'' in the left navigation
Click the icon with the little plus sign left from the Aimeos list entry (looks like a lego brick)

Database

Afterwards, you have to execute the update script of the extension to create the required database structure:

Page setup

The page setup for an Aimeos web shop is easy if you import the example page tree for TYPO3 9/10:

Note: The Aimeos layout expects Bootstrap providing the grid layout!

Go to the import view

In Web::Page, root page (the one with the globe)
Right click on the globe
Move the cursor to "Branch actions"
In the sub-menu, click on "Import from .t3d"

Upload the page tree file

In the page import dialog
Select the "Upload" tab (2nd one)
Click on the "Select" dialog
Choose the file you've downloaded
Press the "Upload files" button

Import the page tree

In Import / Export view
Select the uploaded file from the drop-down menu
Click on the "Preview" button
The pages that will be imported are shown below
Click on the "Import" button that has appeared
Confirm to import the pages

Now you have a new page "Shop" in your page tree including all required sub-pages.

SEO-friendly URLs

TYPO3 9.5 and later can create SEO friendly URLs if you add the rules to the site config: https://aimeos.org/docs/latest/typo3/setup/#seo-urls

License

The Aimeos TYPO3 extension is licensed under the terms of the GPL Open Source license and is available for free.

aisling11/aimeos-typo3