Skip to main content

Installation

Requirements​

ComponentMinimum Version
WordPress5.9+
PHP8.0+
WooCommerce (optional)7.0+ for lead capture
StorePilot PlatformRunning NestJS server

Step 1: Platform Account​

Before installing the Plugin, you need an account on the StorePilot Platform.

  1. Go to https://dashboard.store-pilot.net/register
  2. Enter your email and password
  3. You will be taken to the Sites screen

Step 2: Add Your WordPress Site​

  1. In the dashboard, click "Add Site"
  2. Enter your site name and domain (e.g. mystore.com)
  3. The Platform generates a unique API Key for this site
  4. Copy the API key — you will need it in Step 4

Step 3: Install the WordPress Plugin​

From WordPress Admin:

  1. Go to Plugins → Add New
  2. Search for "StorePilot"
  3. Click Install Now → Activate

Manual upload:

  1. Download the .zip from the Platform dashboard or WordPress.org
  2. Go to Plugins → Add New → Upload Plugin
  3. Upload the .zip and click Activate

On activation, the plugin automatically:

  • Installs required database tables
  • Copies an MU-plugin loader to wp-content/mu-plugins/ (ensures plugin loads early enough to catch PHP errors)

Step 4: Configure the Plugin​

  1. In WordPress Admin, go to StorePilot → Settings
  2. Enter the Platform URL: https://api.store-pilot.net
  3. Paste your API Key from Step 2
  4. Click Save Changes

The plugin will verify the API key against the Platform. A green status indicator confirms the connection is working.

Step 5: Verify Data Is Flowing​

  1. Open your website in a browser
  2. Wait ~30 seconds
  3. In the Platform dashboard, check Sites → [Your Site] → Stats
  4. You should see a pageview registered

If no data appears, see the Troubleshooting section below.

Troubleshooting​

No data appears in the dashboard:

  • Check that the API Key is entered correctly in Plugin Settings
  • Check that the Platform URL does not have a trailing slash
  • Open browser DevTools → Network tab, look for requests to api.store-pilot.net
  • Check WordPress error log for any PHP errors from the plugin

"API key invalid" error:

  • Regenerate the API key in Dashboard → Sites → [Site] → Settings
  • Paste the new key in the Plugin Settings

Plugin fails to activate:

  • Verify PHP 8.0+ is running: in WordPress Admin → Tools → Site Health → PHP Version
  • Check that wp-content/mu-plugins/ is writable by the server

Uninstallation​

To fully uninstall:

  1. Deactivate the plugin in Plugins screen
  2. Click Delete

The uninstaller automatically:

  • Drops custom database tables (wpel_leads, wpel_visitors, wpel_pageviews)
  • Removes all plugin options from wp_options
  • Removes the MU-plugin loader file

Your data on the Platform server is not deleted automatically. To delete site data, go to Dashboard → Sites → [Site] → Delete Site.