Installation and Configuration

The Netacea Magento integration detects bot activity and performs mitigating actions in line with the client blocking strategy.

Prerequisites

To successfully integrate using Netacea, please ensure you have:

  1. A Fastly version or 1.2.217+ or higher. That is the version where the Netacea Edge module for the integration is added.

  2. Access to the relevant API keys and log shipping endpoints in the Netacea portal.

Customers will also need to open a support ticket with Magento to request Fastly to enable POST within their environment. We need to ensure that there are 2 pragmas enabled on your Fastly account that are not enabled by default.

Required Pragmas:

Pragma optional_param fix_unsent_body_drain true;
Pragma optional_param no_body_if_bereq_is_get_or_head true;

To enable the Pragmas raise a support ticket with Fastly/Magento support. These Pragmas cannot be added manually.

Implementation Steps

  • Log in to the Fastly/Magento web interface.

  • Check the Pragmas outlined in the prerequisite section have been enabled by navigating to Stores → Configuration → Advanced → System → Full Page Cache → Fastly Configuration → Tools → List all versions.

  • Show the latest VCL version and look for the Pragmas at the top of the VCL.

Make a note of the current version should you need to roll back in the future.

Install the Netacea Edge Module

Navigate to Stores → Configuration → Advanced → System → Full Page Cache → Fastly Configuration → Fastly Edge Modules and click "Manage" on the Module Manager.

  • Tick the "Netacea Bot Detection integration" Edge Module and click "Save".

Apply customer keys to the Module

  • Navigate to the Active Modules and click the "Netacea Bot Detection integration" Action cog.

Input the required fields

FieldValue

Integration Mode

BYPASS - Disables the Netacea integration entirely

INGEST - Passive mode to allow Netacea to collect and analyse traffic

MITIGATE - Active mode that will mitigate based on Netacea's Intent Analytics®

INJECT - Active mode for customers who wish to receive Netacea analytics at their backend and decide actions to take.

Netacea API Key

Provided by Netacea portal

Netacea Secret

Provided by Netacea portal

Encryption Key

Provided by Netacea portal

Netacea cookie name

A suitable name for your mitigation cookie.

For added security, do not include Netacea or Mitigation in this name.

Netacea captcha cookie name

A suitable name for your Captcha tracking cookie.

For added security, do not include Netacea or Mitigation in this name.

Netacea ignore list - URL Paths

/static/,/media/

Optional Fields - Can be set to blank unless discussed with the Netacea team

FieldValue

Real IP Header Name

Allows users to customise which header is used for the request's IP.

Leave blank by default to use Fastly standard client.IP field.

Use Relative Captcha Page Assets

If set to true, it ensures Captcha is served without references to the Netacea CDN. Otherwise it will embed full URL to Netacea CDN in Captcha HTML. Leave blank by default to use HTML sitewide.

Captcha URL Path

Allows users to create an endpoint which always serve Captcha HTML. Useful when implementing captcha challenge for mobile apps. Leave blank by default to use /ATAverify pathway.

Captcha Page Marker Header

Custom header that indicates if the response is Captcha page. Has to be in format of name={{header name}}&value={{header value}}.

Captcha Page Marker Header

Applies a header to the users requests to show that a captcha has been served.

Leave blank by default.

Example value name=X-Captcha-Served&value=true

Enable Captcha Content Negotiation

Handles the format of the Captcha page. when set to true then it's possible to for the integration to return get the Captcha page in form of JSON. Leave blank by default to use HTML sitewide.

Create an empty Dictionary

Navigate to Stores → Configuration → Advanced → System → Full Page Cache → Fastly Configuration → Edge Dictionaries and click "Add Dictionary".

Create a dictionary with the name "netacea_edge_config", this can be left blank.

This will only be populated when using Advanced Configuration on the advice of Netacea

Finishing Up

Check you have completed the following steps:

You are now ready to deploy by clicking "Save Config"

A Cache flush can sometimes be required. To do this go to System -> Cache Management and click "Flush Magento Cache"

Bot management will now be deployed on the Fastly/Magento environment. You can test the deployment is active by:

  • Checking for the presence of the Netacea cookie on the website

  • Viewing your reporting dashboard for traffic and mitigation

  • Requesting Netacea review internal metrics

Last updated

Copyright Netacea 2023