Server-Side Integration on N7 Docs

SERA integration on Akamai

Mon, 01 Jan 0001 00:00:00 +0000

Kindly follow the below steps to setup the routing of bot traffic to SERA.

Prerequisites#

All your page requests must get intercepted by below SERA routing rule
- Please check your routing, caching and cache-variation policies for that
If caching is enabled, Users and Bots should have a separate cache-variations configured. This is to not serve the SERA’s bot-optimized-content to users.

Steps#

Open Akamai Dashboard, and Create new Configuration Version

SERA integration on Apache Web Server

Mon, 01 Jan 0001 00:00:00 +0000

Kindly follow the below examples to setup the routing of bot traffic to SERA.

Prerequisites#

All your page requests must get intercepted by below SERA routing rule
- Please check your routing, caching and cache-variation policies for that
If caching is enabled, Users and Bots should have a separate cache-variations configured. This is to not serve the SERA’s bot-optimized-content to users.

Steps#

Change SERA_ENDPOINT to the SERA endpoint shared with you
Change YOUR_TOKEN to the SERA token shared with you
Change YOUR_DOMAINS_SECRET_TOKEN to the SERA token shared with you
Change example.com (server_name) to your actual domain
Change /path/to/your/root to the correct value
Keep the relevant bot user-agent regex condition mentioned below - to control the traffic being sent to SERA


LoadModule dir_module modules/mod_dir.so
LoadModule authz_core_module modules/mod_authz_core.so
LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_http_module modules/mod_proxy_http.so
LoadModule rewrite_module modules/mod_rewrite.so
LoadModule headers_module modules/mod_headers.so
LoadModule ssl_module modules/mod_ssl.so

<VirtualHost *:8080>
	ServerName example.com
	DocumentRoot /path/to/your/root/

	<Directory "/path/to/your/root/">
		Options Indexes FollowSymLinks
		AllowOverride All
		Require all granted
	</Directory>

	#added for sera
	RewriteEngine On
	SSLProxyEngine On

	#added for sera
	<IfModule mod_headers.c>
		RequestHeader set x-nv-sera-token "YOUR_TOKEN"
		RequestHeader set x-nv-access-key "YOUR_DOMAINS_SECRET_TOKEN"
	</IfModule>

	#added for sera
	<IfModule mod_rewrite.c>
		<IfModule mod_proxy_http.c>
			#USE THIS RewriteCond - DURING POC PHASE for bot User-Agent check :
			RewriteCond %{HTTP_USER_AGENT} (n7TestUserAgent|google\\ page\\ speed|chrome-lighthouse|google-inspectiontool|PTST|GTmetrix|n7ua) [NC,OR]
			#USE THIS RewriteCond - ON GOING LIVE ON SERA for bot User-Agent check :
			#RewriteCond %{HTTP_USER_AGENT} (n7TestUserAgent|google\\ page\\ speed|chrome-lighthouse|google-inspectiontool|PTST|GTmetrix|n7ua|googlebot|facebookexternalhit|bingbot) [NC,OR]
			#USE THIS RewriteCond - ON GOING LIVE ON SERA for AI bots for bot User-Agent check :
			#RewriteCond %{HTTP_USER_AGENT} (openai|gptbot|claudebot|claude-user|perplexity-user|perplexity-bot|google-extended|google-cloudvertexbot|google-notebooklm|amazonbot|duckassistbot|metaai|metabotic|meta-externalagent|copilot|baiduspider) [NC,OR]
			RewriteCond %{QUERY_STRING} _escaped_fragment_

			RewriteCond %{REQUEST_METHOD} ^GET$
			RewriteCond %{HTTP:X-NV-APP} ^$
			RewriteCond %{HTTP:X-NV-SERA-BYPASS} ^$
			RewriteCond %{REQUEST_URI} ^(|.+\.html|.+\.aspx|.+\.php)($|\?.*) [NC]
			RewriteCond %{REQUEST_URI} !.*(/static/|/_next/|/api/|/login|/logout|/account/|/wishlist/|/cart/|/checkout/|/payment/).* [NC]
			RewriteCond %{QUERY_STRING) !(^|&)nsbp=[^&]+ [NC]
			
			#USE THIS IF YOUR SITEMAP PAGE URLS DO NOT HAVE QUERYSTRING
			RewriteRule (.*) SERA_ENDPOINT? [P,END]
			#USE THIS IF YOUR SITEMAP PAGE URLS HAVE QUERYSTRING
			RewriteRule (.*) SERA_ENDPOINT [P,END]
		</IfModule>
	</IfModule>
</VirtualHost>

You can test the Apache configuration on Fiddle

SERA integration on Cloudflare

Mon, 01 Jan 0001 00:00:00 +0000

Kindly follow the below steps to setup the routing of bot traffic to SERA.

Prerequisites#

This configuration will only work if site DNS is in Proxy mode

Else, if your pages are not cached, you can set it at origin server (Nginx , Apache , custom etc.)
All your page requests must get intercepted by Cloudflare origin-rule or Worker
- Please check your routing, caching and cache-variation policies for that
Users and Bots should have a separate cache-variations configured. This is to not serve the SERA’s bot-optimized-content to users.

Steps#

Select the steps according to your plan:

SERA integration on CloudFront

Mon, 01 Jan 0001 00:00:00 +0000

Kindly follow the below steps to setup the routing of bot traffic to SERA.

Prerequisites#

Your origin server does not need host header to manage routing.
This is because while forwarding bot requests to SERA, you need to send the SERA’s host header instead of your domain’s header on the request (to avoid SAN error).
For this, you need to attach AllViewerExceptHostHeader as Origin request policy to the respective behavior that’ll be forwarding the bot request. In this case, if your origin is expecting host header to route the request, it will fail.

SERA integration on other web-servers

Mon, 01 Jan 0001 00:00:00 +0000

If you are using a web-server for which SERA integration steps are not provided here, just follow the steps below.
Sending requests to SERA is simple: all you need is a SERA token and a simple proxy configuration.

Prerequisites#

All your page requests must get intercepted by below SERA routing rule
- Please check your routing, caching and cache-variation policies for that
If caching is enabled, Users and Bots should have a separate cache-variations configured. This is to not serve the SERA’s bot-optimized-content to users.

Steps#

1. Identify Matching Requests#

1.1 Request-Method#

Only the GET requests should be sent to SERA.

1.2 User-Agent Pattern#

Requests matching only the mentioned bot user-agents should be sent to SERA.
You can define a regular expression or other matching criteria to identify requests that should be proxied to SERA.

SERA integration on Fastly

Mon, 01 Jan 0001 00:00:00 +0000

Kindly follow the below steps to setup the routing of bot traffic to SERA.

Prerequisites#

All your page requests must get intercepted by below SERA routing rule
- Please check your routing, caching and cache-variation policies for that
If caching is enabled, Users and Bots should have a separate cache-variations configured. This is to not serve the SERA’s bot-optimized-content to users.

Steps#

Kindly follow the below examples to setup the routing of bot traffic to SERA.

SERA integration on Nginx

Mon, 01 Jan 0001 00:00:00 +0000

Kindly follow the below examples to setup the routing of bot traffic to SERA.

Prerequisites#

This configuration will only work if you have set proxy_ssl_server_name on; in server block
All your page requests must be reaching nginx
- Please check your caching and cache-variation policies for that
If caching is enabled, Users and Bots should have a separate cache-variations configured. This is to not serve the SERA’s bot-optimized-content to users.

Steps#

Change SERA_ENDPOINT to the SERA endpoint shared with you
Change YOUR_TOKEN the SERA token shared with you
Change example.com for server_name to your actual domain
Change /path/to/your/root to the correct value
Keep the relevant bot user-agent regex condition mentioned below - to control the traffic being sent to SERA


worker_processes auto;

events {
	worker_connections 1024;
}

http {
	include mime.types;
	default_type application/octet-stream;

	sendfile on;
	keepalive_timeout 65;
	map_hash_bucket_size 1024;

	map $http_user_agent $sera_ua_check { #added for sera
		default 0;
		"~*sera" 0;
		"~(^|&)_escaped_fragment_=" 0;

		#USE THIS - DURING POC PHASE for bot User-Agent regex check :
		"~*(n7TestUserAgent|google\ page\ speed|chrome-lighthouse|google-inspectiontool|PTST|GTmetrix|n7ua)" 1;
		#USE THIS - ON GOING LIVE ON SERA for bot User-Agent regex check :
		#"~*(n7TestUserAgent|google\ page\ speed|chrome-lighthouse|google-inspectiontool|PTST|GTmetrix|n7ua|googlebot|facebookexternalhit|bingbot)" 1;
		#USE THIS - ON GOING LIVE ON SERA for AI bots for User-Agent regex check :
		#"~*(openai|gptbot|claudebot|claude-user|perplexity-user|perplexity-bot|google-extended|google-cloudvertexbot|google-notebooklm|amazonbot|duckassistbot|metaai|metabotic|meta-externalagent|copilot|baiduspider)" 1;
	}

	map $request_method $sera_method_check { #added for sera
		default $sera_ua_check;
		POST 0;
		PUT 0;
		DELETE 0;
		OPTIONS 0;
		HEAD 0;
		PATCH 0;
		CONNECT 0;
		TRACE 0;
	}

	map $request_uri $sera_ext_check { #added for sera
		default $sera_method_check;
		"~*\.(ai|ashx|asmx|aspx|avi|avif|bmp|css|csv|dat|dmg|doc|eot|exe|flv|gif|ico|iso|jpeg|jpg|js|json|jsp|less|m4a|m4v|mov|mp3|mp4|mpeg|mpg|ogg|otf|pdf|php|png|ppt|psd|rar|rss|svg|swf|tif|torrent|tf|txt|wav|webm|webp|wmv|woff|woff2|xls|xml|zip)" 0;
	}

	map $request_uri $sera_url_check { #added for sera
		default $sera_ext_check;
		"~*.*(/static/|/_next/|/api/|/login|/logout|/account/|/wishlist/|/cart/|/checkout/|/payment/).*" 0;
	}

	map $args $sera_qry_check { #added for sera
		default $sera_url_check;
		"~*\bnsbp=" 0;
	}

	map $http_x_nv_app $sera_app_check { #added for sera
		default $sera_qry_check;
		"~.+" 0;
	}

	map $http_x_nv_sera_bypass $sera_final_check { #added for sera
		default $sera_app_check;
		"~.+" 0;
	}

	server {
		listen 80;

		server_name example.com;
		proxy_ssl_server_name on;

		root /path/to/your/root;

		location / {
			if ($sera_final_check = 1) { #added for sera
				rewrite (.*) /sera_target/$1 last;
			}

			#existing configuration
			#try_files $uri /index.html = 404;
		}

		location /sera_target { #added for sera
			#forward request to sera to serve the optimized page
			resolver 8.8.8.8 1.1.1.1;
			set $sera_host SERA_ENDPOINT;
			proxy_set_header host $sera_host;
			proxy_set_header x-nv-sera-token YOUR_TOKEN;
			proxy_set_header x-nv-access-key YOUR_N7_ACCESS_KEY;
			set $args ""; #REMOVE THIS IF YOUR SITEMAP PAGE URLS HAVE QUERYSTRING
			rewrite /sera_target/(.*) $1 break;
			proxy_pass https://$sera_host;
		}
	}
}

You can test the Nginx configuration on Fiddle

SERA integration on Node

Mon, 01 Jan 0001 00:00:00 +0000

Kindly follow the below examples to setup the routing of bot traffic to SERA.

Prerequisites#

All your page requests must get intercepted by below SERA routing rule
- Please check your routing, caching and cache-variation policies for that
If caching is enabled, Users and Bots should have a separate cache-variations configured. This is to not serve the SERA’s bot-optimized-content to users.

Steps#

Change SERA_ENDPOINT to the SERA endpoint shared with you
Change YOUR_TOKEN to the SERA token shared with you
Keep the relevant bot user-agent regex condition mentioned below - to control the traffic being sent to SERA


const express = require('express');
const app = express();
const port = 3000;


const seraEndpoint = 'SERA_ENDPOINT';
const seraToken = 'YOUR_TOKEN';
const n7AccessKey = 'N7_ACCESS_KEY';
//USE THIS - DURING POC PHASE for bot User-Agent regex :
const seraUserAgentPattern = /(n7TestUserAgent|google page speed|chrome-lighthouse|google-inspectiontool|PTST|GTmetrix|n7ua)/i;
//USE THIS - ON GOING LIVE ON SERA for bot User-Agent regex :
//const seraUserAgentPattern = /(n7TestUserAgent|google page speed|chrome-lighthouse|google-inspectiontool|PTST|GTmetrix|n7ua|googlebot|facebookexternalhit|bingbot)/i;
//USE THIS - ON GOING LIVE ON SERA for AI bots for bot User-Agent regex :
//const seraUserAgentPattern = /(openai|gptbot|claudebot|claude-user|perplexity-user|perplexity-bot|google-extended|google-cloudvertexbot|google-notebooklm|amazonbot|duckassistbot|metaai|metabotic|meta-externalagent|copilot|baiduspider)/i;
const seraAllowedExtnPattern = /^(|.+\.html|.+\.aspx|.+\.php)($|\?.*)/i;
const seraExludeQryPrmPattern = /\?(.*&)*(nsbp)=.*/i;
const seraExludePagePattern = /.*(\/static/|\/_next\/|\/api\/|\/login|\/logout|\/account\/|\/wishlist\/|\/cart\/|\/checkout\/|\/payment\/).*/i;

const sera = async (req, res, next) => {
	const { "user-agent": userAgent, "accept-encoding": acceptEncoding, accept, referer } = req.headers;

	if (req.method === "GET"
		&& seraUserAgentPattern.test(userAgent) 
		&& seraAllowedExtnPattern.test(req.url)
		&& !seraExludeQryPrmPattern.test(req.url)
		&& !seraExludePagePattern.test(req.url)
		&& !req.headers['x-nv-app']
		&& !req.headers['x-nv-sera-bypass']) {
		
		const headers = {
			'x-nv-sera-token': seraToken,
			'x-nv-access-key': n7AccessKey,
			'user-agent': userAgent || '',
			'accept-encoding': acceptEncoding || '',
			'accept': accept || '',
			'referer': referer || '',
		};

		const remoteUrl = `${seraEndpoint}${req.url.pathname}`; //USE THIS IF YOUR SITEMAP PAGE URLS DO NOT HAVE QUERYSTRING
		const remoteUrl = `${seraEndpoint}${req.url}`; //USE THIS IF YOUR SITEMAP PAGE URLS HAVE QUERYSTRING

		try {
			const response = await fetch(remoteUrl, { headers });
			if ((response.status === 200 || response.status === 410) && response.data) {
				res.status(response.status).send(response.data);
			}
			else {
				next();
			}
		} catch (error) {
			console.error('error downloading page:', error.message);
			next();
		}
	}
	else {
		next();
	}
}

app.use(sera);

app.get('/', (req, res) => {
	res.send('Hello World!')
})

app.listen(port, () => {
	console.log(`example app listening on port ${port}`)
})

Keep refining the logic by adjusting user-agent list, and SERA exclusion-patterns as needed.

Server-Side Integration on N7 Docs

SERA integration on Akamai

Prerequisites#

Steps#

SERA integration on Apache Web Server

Prerequisites#

Steps#

Testing and Refinement#

SERA integration on Cloudflare

Prerequisites#

Steps#

SERA integration on CloudFront

Prerequisites#

SERA integration on other web-servers

Prerequisites#

Steps#

1. Identify Matching Requests#

1.1 Request-Method#

1.2 User-Agent Pattern#

SERA integration on Fastly

Prerequisites#

Steps#

SERA integration on Nginx

Prerequisites#

Steps#

Testing and Refinement#

SERA integration on Node

Prerequisites#

Steps#

Testing and Refinement#