README

Webscale Varnish is a Shopware plugin that connects your store’s full page cache to the Webscale Control Plane, so your store is cached – and stays in sync – at the edge.

In short: Shopware → Webscale Varnish (this plugin) → Webscale Control Plane → Varnish at the edge.

• Supports: Shopware 6.7.3 and onward
• Needs: Webscale account (API token + Application ID / environment)
• Docs: See Further documentation

How it works (high level)

Webscale Varnish does not invent its own cache invalidation rules. Instead it relays Shopware’s existing invalidations to the Webscale platform:

Shopware → Webscale Varnish (this extension) → Webscale Control Plane → Varnish

• Shopware generates cache invalidation events based on your store configuration.
• The Webscale Varnish extension receives those events and sends them to Webscale.
• The Webscale Control Plane applies the invalidations to your edge Varnish cache.

Misconfigured or overly aggressive invalidation in Shopware will therefore still result in frequent cache flushes at the edge.

Requirements

• Shopware: 6.7.3 and onwards
• A Webscale account with:
  • API token
  • Application ID / environment configured for your Shopware store

Quick start (installation)

Run the following in your Shopware root directory.

1. Require the extension

   composer require webscale-networks/shopware-varnish-api

2. Enable the plugin

   bin/console plugin:refresh
   bin/console plugin:install --activate WebscaleVarnish
   bin/console cache:clear

3. Log into the Shopware Admin

   After deployment, log into the Shopware admin panel to complete configuration.

Configure Webscale Varnish

Once the module is installed, configure it in the Shopware admin.

1. Configure Webscale credentials

1. In the Shopware admin, go to:

   Extensions > My extensions > Webscale Varnish
   

2. Enable plugin and configure credentials:

   • Set Enabled to Yes.
   • Enter your API token.
   • Enter your Application Id (the Webscale application that corresponds to this Shopware store).

3. Click Save.

Debug mode

Enable Debug Mode under the Developer Settings section to get more detailed logs from the extension.

• Log file path: var/log/webscale-varnish.log in your Shopware root.
• Use this when troubleshooting cache behavior or connectivity with Webscale.

Further documentation

Platform-wide Webscale and Varnish documentation, configuration guidance, and troubleshooting guides are available at:

• https://docs.webscale.com/