Skip to main content

Installation Guide

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

System Requirements​

Before installing the OpenAI Assistants Manager, ensure your system meets the following requirements:

  • Shopware 6.4.0 or higher
  • PHP 7.4 or higher
  • MySQL 5.7 or higher
  • OpenAI API Key with available credits

Installation Methods​

  1. Log in to your Shopware Administration
  2. Navigate to Extensions > My Extensions
  3. Search for "OpenAI Assistants Manager" or "5E OAI Assistants Manager"
  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 5EOAIAssistantsManager
bin/console cache:clear

Initial Configuration​

After installation, you'll need to configure the plugin with your OpenAI API key:

  1. Navigate to Settings > Extensions > OpenAI Assistants Manager
  2. Enter your OpenAI API Key in the designated field
  3. Click Test API Key to verify the connection
  4. If the key is valid, click Save

Verifying Installation​

To verify that the plugin is installed and configured correctly:

  1. Navigate to the Shopware Administration
  2. Look for the OpenAI Assistants Manager entry in the main menu
  3. Click on it to access the plugin's main interface
  4. You should see the main dashboard with options to manage assistants, files, and vector stores

Troubleshooting​

If you encounter issues during installation:

API Key Issues​

  • Ensure your OpenAI API key is valid and has available credits
  • Check that you've entered the key correctly without any extra spaces
  • Verify that your OpenAI account has billing information set up

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

Connection Issues​

  • Ensure your server can connect to the OpenAI API (outbound connections to api.openai.com)
  • Check your server's firewall settings
  • Verify that your PHP configuration allows outbound HTTP requests

Next Steps​

Once you've successfully installed and configured the OpenAI Assistants Manager, you can proceed to:

  1. Create your first assistant
  2. Set up the content checker
  3. Configure tags for logging
  4. Explore available tools

For more detailed information about using the plugin, refer to the main documentation pages.