README

A Shopware 6 plugin that serves as a connector for Shopmon Shop Monitoring with automatically generated, easy to configure access credentials.

Features

🔐 Automatic Integration Creation: Creates a Shopware integration with all necessary permissions automatically
🔑 Secure Credential Generation: Generates secure access keys and client secrets
📦 Base64 Encoded Storage: Stores integration data as Base64-encoded JSON in system configuration
🔄 Upsert Functionality: Updates existing integration instead of creating duplicates
⚙️ Easy Configuration: Integration data is visible in the admin panel for easy setup
🛡️ Proper Permissions: Includes all required permissions for shop monitoring

Permissions

The plugin automatically creates an integration with the following permissions:

app:read - Read access to apps
plugin:read - Read access to plugins
system_config:read - Read access to system configuration
scheduled_task:read - Read access to scheduled tasks
frosh_tools:read - Read access to FroshTools (if installed)
system:clear:cache - Permission to clear cache
system:cache:info - Permission to get cache information

Installation

Via Plugin Manager

Download the plugin
Upload it via the Plugin Manager in your Shopware Administration
Install and activate the plugin

Via Composer

composer require frosh/shopmon
bin/console plugin:refresh
bin/console plugin:install --activate FroshShopmon

Manual Installation

Download the plugin
Extract it to custom/plugins/FroshShopmon
Install via command line:

bin/console plugin:refresh
bin/console plugin:install --activate FroshShopmon

Configuration

After installation, the integration data will be automatically generated and stored. You can view the Base64-encoded integration data in:

Administration → Settings → Extensions → FroshShopmon

The integration data contains:

Shop URL (from APP_URL environment variable)
Client ID (automatically generated)
Client Secret (automatically generated)

Usage with Shopmon

Install and activate the FroshShopmon plugin
Navigate to the plugin configuration in the admin panel
Copy the Base64-encoded integration data
Use this data to configure your Shopmon monitoring setup

Development

Requirements

Shopware 6.5.0 or higher
PHP 8.1 or higher

Testing

# Validate plugin structure
shopware-cli extension validate /path/to/FroshShopmon

# Install for testing
bin/console plugin:install --activate FroshShopmon

# Uninstall
bin/console plugin:uninstall FroshShopmon

Technical Details

Integration Management

The plugin uses a fixed integration ID (a1b2c3d4e5f6789012345678901234ab) to ensure that reinstalling the plugin updates the existing integration rather than creating duplicates.

Environment Variables

The plugin uses Shopware's EnvironmentHelper to read the APP_URL environment variable, falling back to http://localhost if not set.

Data Storage

Integration credentials are stored as Base64-encoded JSON in the system configuration under the key FroshShopmon.config.integrationData.

Compatibility

Shopware 6.5.x ✅
Shopware 6.6.x ✅
Shopware 6.7.x ✅

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support and issues, please visit:

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Changelog

1.0.0

Initial release
Automatic integration creation with monitoring permissions
Base64-encoded credential storage
Support for Shopware 6.5, 6.6, and 6.7

frosh / shopmon

Maintainers

Details