Skip to main content

Installation Guide

This guide will walk you through the process of installing and setting up the FelAIProductAdvisor plugin for your Shopware store.

System Requirements​

Before installing FelAIProductAdvisor, ensure your system meets the following requirements:

  • Shopware 6.5.x or higher
  • PHP 8.0 or higher
  • MySQL 5.7 or higher
  • Active OpenAI account with API key
  • Installed and configured FelOAIAssistantsManager plugin (base plugin)

Prerequisites​

Before installing FelAIProductAdvisor, make sure that the base plugin FelOAIAssistantsManager is already installed and configured. FelAIProductAdvisor builds on this base plugin and uses its functions for OpenAI integration.

Checking the Base Plugin Configuration​

  1. Navigate to Settings > System > Plugins
  2. Search for "FelOAIAssistantsManager" and click on "Configure"
  3. Ensure that a valid OpenAI API key is entered
  4. Check if the desired AI models are activated (recommended: GPT-4o-mini for good value for money)

Installation Methods​

  1. Log in to your Shopware Administration
  2. Navigate to Extensions > My Extensions
  3. Search for "FelAIProductAdvisor" or "AI Product Advisor"
  4. Click Install
  5. Activate the plugin by clicking the toggle switch

Method 2: Manual Installation​

If you prefer to install the plugin manually:

  1. Download the plugin ZIP file from your account or the provided source
  2. Extract the ZIP file
  3. Copy the extracted folder to the custom/plugins directory of your Shopware installation
  4. Run the following commands in your Shopware root directory:
bin/console plugin:refresh
bin/console plugin:install --activate FelAIProductAdvisor
bin/console cache:clear

Post-Installation Steps​

After installing the plugin, you need to complete a few additional steps:

1. Clear Cache​

Clear the Shopware cache to ensure all plugin components are properly loaded:

bin/console cache:clear

2. Rebuild Storefront Assets​

Compile the storefront assets to include the plugin's CSS and JavaScript files:

./bin/build-storefront.sh

3. Verify Installation​

To verify that the plugin is installed correctly:

  1. Navigate to the Shopware Administration
  2. Go to Content > Shopping Experiences
  3. Edit any CMS page or create a new one
  4. Check if the "FEL AI Product Advisor" element is available in the elements list

Initial Configuration​

After installation, you don't need to configure separate API keys for FelAIProductAdvisor, as these are taken from the base plugin FelOAIAssistantsManager.

The main configuration of the product advisor happens when you add it as a CMS element to your pages. Each instance of the product advisor can be configured individually with different settings.

Troubleshooting​

If you encounter issues during installation:

Plugin Not Appearing​

  • Clear your browser cache
  • Run bin/console cache:clear from your Shopware root directory
  • Check the Shopware logs for any error messages

CMS Element Not Available​

  • Make sure the plugin is activated
  • Rebuild the storefront assets
  • Check if there are any JavaScript errors in the browser console

Connection Issues​

  • Verify that the OpenAI API key in the base plugin is valid
  • Check if your server can connect to the OpenAI API
  • Ensure your OpenAI account has sufficient credits

Next Steps​

Once you've successfully installed FelAIProductAdvisor, you can proceed to:

  1. Create your first product advisor
  2. Configure AI settings
  3. Customize the design
  4. Explore usage examples

For more detailed information about using the plugin, refer to the other sections of this documentation.