Platform Integrations

Edgemesh® provides installation instructions for various platforms such as Cloudflare, Fastly, Hubspot, Magento, Salesforce Commerce Cloud, Shopify, and WordPress. If you don't see your platform here, and you are not able to perform a generic installation please contact Edgemesh® Support.

Cloudflare

If you are an existing Cloudflare customer, the Edgemesh® for Cloudflare App provides a one-click method to enable Edgemesh® Client. The Edgemesh® App is available on the Cloudflare App Store.

The Edgemesh® Client app requires Cloudflare Workers to be enabled on your account and for the website to be proxied (Orange Cloud) via Cloudflare. The Edgemesh® App creates a Worker under the covers that will listen on the /sw.js path and uses the App system to inject the Edgemesh® Client on your website.

Cloudflare Install

Once the app is installed on your Cloudflare-enabled site you can validate the installation via the Edgemesh Portal.

Fastly

The Edgemesh® Client can be enabled using Fastly Compute at Edge (C@E). Similar to the Cloudflare installation, the Fastly C@E worker ensures that the /sw.js route returns the Edgemesh® Service Worker. Aside from the C@E worker code, you will need to add the Edgemesh® client to the <head> of your website:

Add the Client

Add Client
<script async type="application/javascript" src="https://static.edgeme.sh/client.js"></script>

Create the Worker Next up, just create a Compute at Edge service to serve the Edgemesh® Service Worker:

Create C@E Worker
const backend = 'your-backend'
const text = "importScripts('https://static.edgeme.sh/edgemesh-sw.js')"


function handleRequest (request) {
  const url = new URL(request.url)


  if (request.method === 'GET' && url.pathname === '/sw.js') {
    const headers = new Headers()
    headers.set('Content-Type', 'application/javascript')


    return new Response(text, {
      url: request.url,
      status: 200,
      headers
    })
  }


  const cacheOverride = new CacheOverride('override', {
    ttl: 60 * 60 * 24 * 365
  })


  return fetch(request, { backend, cacheOverride })
}


addEventListener('fetch', event => event.respondWith(handleRequest(event)))

Hubspot

Installing Edgemesh® Client on the Hubspot platform is a simple three-step process.

Create the Service Worker

To add the service worker file, and allow this file to be served on the site's root - begin by creating a file called sw.js which contains the following line of javascript:

Service Worker Content
importScripts('https://static.edgeme.sh/edgemesh-sw.js')

Create Proxy

We will then upload this to Hubspot via the file manager and add a redirect:

  1. Upload the sw.js file to the file manager.
  2. Go to Settings > Domains & URLs > Url Redirects.
  3. Click the Add URL Redirect button.
  4. Redirect Type: Standard.
  5. Original Url: The file manager URL where the new sw.js file was created, such as /hubfs/sw.js.
  6. Redirect to: The internet-facing path e.g. https://hubspotsite.com/sw.js.
  7. Click More Options.
  8. Redirect style: Proxy.
  9. Select Ignore trailing slash and `Ignore protocol``.
  10. Click Add URL Redirect.

Add the Client

The first step is to add the Edgemesh® Client to the site. This is outlined in the following Hubspot document.

Per this support document, in the "Include your JavaScript file on your HubSpot pages" section, please enter the following code:

Client Script
<script async type="application/javascript" src="https://static.edgeme.sh/client.js"></script>

You can now complete your installation by verifying your domain on the Edgemesh® Portal.

Magento

The process to install the Edgemesh® Service Worker is the same for both Magento 1 and Magento 2.

First, you will need to create a file on the root of your web server. The root is usually www/html but if your root is different you can find it quickly by locating the main index.php of your Magento installation.

Once you find the root directory, create a file called sw.js and add the following code:

Service Worker Content
importScripts('https://static.edgeme.sh/edgemesh-sw.js')

Installing the Client will be specific to each version.

Magento 1.X

We will be creating a custom module for Edgemesh® so It can easily be enabled and disabled from System > Configuration > Advanced.

All the file names and content below are case-sensitive. Please copy them exactly.

First, let's create the Edgemesh® Client Loader.

Loader Filename
app/design/frontend/base/default/layout/edgemesh.xml
Loader XML Content
<?xml version="1.0"?>
<layout version="0.1.0">
  <default>
    <reference name="head">
      <block type="core/text" name="mapcontrol.script.block">
        <action method="setText">
          <text><![CDATA[<script async type="application/javascript" data-cfasync="false" src="https://static.edgeme.sh/client.js" onload="window.edgemesh = new Edgemesh()"></script>]]>
          </text>
        </action>
      </block>
    </reference>
  </default>
</layout>

Then create a module config:

Module Filename
app/code/local/Edgemesh/Client/etc/config.xml
Module XML Content
<?xml version="1.0"?>
<config>
  <modules>
    <Edgemesh_Client>
      <version>3.1.0</version>
    </Edgemesh_Client>
  </modules>
  <frontend>
    <layout>
      <updates>
        <module>
          <file>edgemesh.xml</file>
        </module>
      </updates>
    </layout>
  </frontend>
</config>

Finally, let's tell Magento about our module:

Initializer Filename
app/etc/modules/Edgemesh_Client.xml
Initializer XML Content
<?xml version="1.0"?>
<config>
  <modules>
    <Edgemesh_Client>
      <active>true</active>
      <codePool>local</codePool>
    </Edgemesh_Client>
  </modules>
</config>

Now you can refresh your caches by going to System > Cache Management, selecting Configuration and Layouts, selecting Refresh from the action drop-down, and clicking the Submit button.

You can now complete your installation by verifying your domain on the Edgemesh® Portal.

Magento 2.X

Navigate to your admin area and go to Content > Configuration:

Magento Configuration

Click edit on your active store view:

Magento Edit Store View

Scroll down to Other Options > HTML Head and find the Scripts and Style Sheets input. Add the following code to the input:

If there are other scripts or style sheets in the input, be sure to add the Edgemesh® Client code on a new line.

Client Script
<script async type="application/javascript" src="https://static.edgeme.sh/client.js"></script>

It should look something like this:

Magento Client Script

Click Save Configuration on the top right.

You can now complete your installation by verifying your domain on the Edgemesh Portal.

Salesforce Commerce Cloud

Installing Edgemesh® Client on Salesforce Commerce Cloud is a simple, three-step process.

Create the Service Worker

The first step is to create the Service Worker file as an SFCC object with the type Content Asset called Edgemesh-Service-Worker or similar. Add the Edgemesh® Service Worker import to the body of this object.

Service Worker Content
importScripts('https://static.edgeme.sh/edgemesh-sw.js')

Create Proxy

Next, we will create a proxy (called an Alias in SFCC context) for our Service Worker. Create an entry in Business Manager > Merchant Tools > SEO > Aliases.

Salesforce Integration

This entry must route /sw.js to the Content Asset created in Step 1 (Edgemesh-Service-Worker).

Alias JSON
{
  "your-host" : [
    {       
      "if-site-path": "/sw.js",
      "pipeline": "Edgemesh-Service-Worker"     
    }   
  ]
}

Confirm that the worker file is now available at the root, for example: https://mysite.com/sw.js.

Once the Service Worker is added, you can complete the integration by adding the Edgemesh® Client code to the head of the website (similar to any other script element).

Client Script Content
<script async type="application/javascript" src="https://static.edgeme.sh/client.js"></script>

You can now complete your installation by verifying your domain on the Edgemesh Portal.

Shopify

Since Shopify has stopped allowing ad-hoc app installations, the Edgemesh Shopify App has been deprecated while we work on integrating with Shopify's billing system. If you have the Edgemesh® Client Shopify App installed, it will continue to function normally. Only new installations are affected. In the meantime, you can install Edgemesh® in lite mode by following the steps below. With Edgemesh® in lite mode, you can take advantage of the Real User Metrics and Script Loader, but the Caching engine will be disabled. If you have a high-traffic site, consider becoming an Edgemesh® Server customer to enable the caching engine and much more. See the Edgemesh® Server offering here and contact sales to get started today!

To install Edgemesh® Client on Shopify, just add the following script to the head tag in your theme.liquid:

Client Script
<script type="application/javascript">
  EDGEMESH = {
    lite: true
  }
</script>
<script async type="application/javascript" src="https://static.edgeme.sh/client.js"></script>

Wordpress

The Edgemesh® WordPress plugin requires at least WordPress version 3.0.1. You can install the plugin directly from your wp-admin by searching for edgemesh or by going to its plugin page directly. You can also download the plugin zip for ad-hoc installation.

You can also install ad-hoc by following the steps below:

  1. Download the latest release above.
  2. In your WordPress dashboard, choose Plugins > Add new.
  3. Click Upload Plugin at the top of the page.
  4. Click Choose File, locate the edgemesh-wordpress-plugin.zip file, then click Install Now.
  5. Activate the plugin.

The WordPress-specific configuration options are available to set at Settings > Edgemesh.

You can now complete your installation by verifying your domain on the Edgemesh Portal.

If you are using wp-rocket, you will need to go to Settings > Edgemesh and turn off async to exclude Edgemesh® from wp-rocket optimizations.

Made withby Edgemesh Corporation