Welcome on N7 Docs

SERA request flow

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

Prerequisite#

You must have an account created on Nitrogen dashboard to view the SERA statistics
SERA must be configured to receive the requests from bots

Flow#

A typical request flow with SERA integration looks like this :

Page serving workflow :
(This is shown at left-hand side of flow in Yellow color)

Crawler requests are received on N7 CDN
If the N7 CDN has page available in cache/storage - it is returned back to crawler
1. If the page page is unavailable in cache/storage :
  1. If a failover is not configured - a 404 is returned to crawler
  2. If a failover is configured - the request is forwarded (proxied) to origin server
    1. Origin server sends the response
    2. SERA receives it, and sends it to crawler

Page rendering workflow :
(This is shown at right-hand side of flow in Yellow color)

Announcements 📢

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

[2024-11-08] [New] Monthly Stats for Log Extracts: We’ve introduced a new feature that gives you an overview of your log extract activity through monthly statistics. You can now track important metrics within your account under Account > Log Extracts, including:
- Cost: Understand the costs associated with your log extract queries, helping you manage budgets more effectively.
- Queries Run: Get a clear view of how many log extract queries were executed within the month.

Application Errors

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

This dashboard will show the 4xx status code data for the configured domains.
Click on Analytics menu, and select Application Errors chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using nviztest.com site data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Charts#

Requests: This chart shows the HTTP status code wise count of the 4xx error requests.

Cache variations

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

Refer this page to configure cache variations.
A typical use case for using this is when you would want to cache/serve different variations of responses for same URL based on some conditions.
e.g. You would want to cache your PDP pages separately, based on the currency with which the prices are shown.
Or you would want to separately cache the page shown to wordpress-admin and normal user.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be configuring cache variation for all the pages based on _wordpress_logged_in_ cookie.

Cache-MISS scenarios

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

Refer this page to know the reasons - when the origin server can get user requests even when caching is enabled, or when CDN can serve old content.

Prerequisite#

You must have caching enabled on domain.

Details#

The content you are accessing is typically served from the regional CDN Point of Presence (PoP) closest to you. However, the requested content may not be available in the cache for the following reasons:

Condition Group

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

Routing conditions can be applied to URLs for routing through the SERA for domains that use the N7 DELIVERY module. Please deploy your domain using the History for these changes to take effect.

Follow these steps to configure conditional group.

NOTE: This section only for N7 clients, for non-N7 clients please refer the instructions

For demo purpose, we will be using example.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.
You must have at least one page group created.
You must have Header and Pattern conditions created. If not, you can refer (Header and URL Patterns ).

Steps#

Click on Rules section, then select Condition Groups.

Configure SERA for domain

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

You can configure SERA for domains by following below steps.

Prerequisite#

You must have an account with Nitrogen
You must have a domain pointing to N7.
You must have a page group created.

Steps#

Select the SERA feature from the top Menu
Once you select the SERA feature, it will navigate to Domains list page
Click on Domain name, It will navigate to Dashboard page, shows the data charts/cards if you already configure the Page Groups for your domain, otherwise it will shows the an Go to Page Groups page

Content blocks

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

Follow these steps to configure conditional blocking. i.e. to block the requests based on conditions.
Typical use-cases are:

block malicious request URLs.
block the IPs you found making malicious requests.
block requests coming from certain bots.
block requests coming from certain countries.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be blocking a certain set of IPs.

Prerequisite#

You must have a domain configured on Nitrogen.
For this example to work, you should have created an IP based condition. If not, you can refer this article for the same.

Steps#

Click on Security menu, then select Content Blocks tab. Select appropriate domain from the domains dropdown.

Cookie conditions

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

This page will show you steps to configure cookie based condition. These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would disable cache for pages when opened in preview mode.
Here, we can achieve it by disabling caching when we have Shopify’s ‘preview_theme’ cookie is present.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be using preview_theme cookie. You can use any relevant cookie

Creating service accounts for programmatic access to Nitrogen APIs

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

You can integrate different Nitrogen APIs in your application, for which you need to have a service account.
Follow these steps to create a service account.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on your ACCOUNT name at top-right corner to open account-level features.

DNS

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

This screen will display you the CNAMEs/A-records that needs to be configured to confirm your ownership over domain, and to move the traffic through Nitrogen.
Please go through this article to get the details.

DNS

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

DNS

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

This screen will display you the CNAMEs/A-records that needs to be configured to confirm your ownership over domain, and to move the traffic through Nitrogen.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have an account on Nitrogen
You must have some domain registered on Nitrogen.

Steps#

Select the respective Account and Domain from the dropdowns at the top right corner.

DNS

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

Header conditions

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

This section shows the steps to configure header based condition.

Typical use-case is, you would want to pass all the bots requests to sera.n7.io .
Here, you can achieve it by providing all Bot patterns by setting the value of user-agent request header.

Note: Header conditions will work only on request-headers.
For demo purpose, we will be using example.com domain as an example. Here, we will only be using googlebot and bingbot user-agent for simplicity.

Human-Detector (HD): Core Security Module Overview

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

What is Human-Detector (HD)?#

The Human-Detector (HD) is a core security module within Nitrogen (N7) designed to distinguish between legitimate human users and automated scripts (bots) interacting with your website or application.

Beyond basic detection, HD analyzes the “request journey” to assess behavioral patterns, enabling it to identify requests with malicious intent and mitigate threats in real-time.

HD is particularly useful for securing high-value and sensitive pages/APIs, such as account login, cart, and checkout flows, where security risks are higher.

Origin Whitelisting with Origin Identity Secret

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

To enhance the security of your origin servers when using Nitrogen (N7), we have introduced the Origin Identity Secret (X-Nv-Access-Key) HTTP header. This feature allows your origin to verify that incoming requests have been processed and forwarded by the N7 network, preventing unauthorized direct access.

This document explains how the X-Nv-Access-Key works, how to manage your secret keys, and how to configure your origin server for seamless key rotation.

Overview#

When enabled, Nitrogen will add a unique X-Nv-Access-Key header to all requests forwarded to your origin server. The value of this header is a secret key that you can manage within the Nitrogen dashboard (dash.n7.io).

Overview

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

Follow these steps if you need to check your account activity, domain details, Account level Analytics, Users details and get the logs for your Account.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Steps#

Click on Account Home dropdown. You will see a list of all your accounts (if you have assigned with multiple accounts).
Select your account (ignore if already selected).

Overview

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

RDX (RealUser Digital eXperience) is a Nitrogen module that gives you complete/clear and thorough idea of the experience that your users are getting based on combination of different factors such as:

WVT metrics
Page load time
Volume of requests
Geography of requests
DeviceTypes

This page will give you a basic idea of Page load, volume, experience.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Steps#

Click on Overview menu. Then Select appropriate domain from the domains dropdown.

Page Groups

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

Congfiring the page group is prerequisite for SERA to fetch the data in various sections or pages,

follow the steps for configure,

Steps#

If page group is NOT configured there will be a prompt to add new page group

Otherwise it will show the configured page groups in this section
If page group NOT configured, click on Add New button, then it will navigate to another screen to configure

Redirects

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

Refer this page to configure redirections for your domain requests.
Typical use-case is, you would want to set country based redirections.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be redirecting all requests from US to /us/*

Prerequisite#

You must have a domain configured on Nitrogen.
You must have a country-based condition configured. Refer guide for it.

Steps#

Click on Domains menu, then select Redirects tab. Select appropriate domain from the domains dropdown.

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

2 Factor Authentication

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

Follow these steps to configure Nitrogen 2 Factor Authentication (Fly Auth) on the desired URLs
Typical use-cases are:

admin pages
reports section

Note: For demo purpose, we will be using www.nviztest.com domain as an example. Here, we will be configuring 2FA on WordPress admin panel pages.

Prerequisite#

You must have a domain configured on Nitrogen.
For this example to work, you should have created URL pattern based condition for WordPRess pattern ^(/wp-admin.php|/wp-admin/.*). If not set, you can refer this article for the same.

Steps#

Click on Security menu, then select 2 Factor Auth tab. Select appropriate domain from the domains dropdown.

Adding a domain to account and enabling services

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

After signing-up on the N7 dashboard, you need to configure your domain on N7 CDN.
You will then be able to enable different features on it like caching, rewrite, redirections, image/video optimizations, SEO related optimizations etc.

Notes:

For demo purpose, we will be using www.nviztest.com domain as an example.
If you are configuring SERA without N7 CDN, follow these steps for it.
If you are using N7 StoreVia feature (N7 storage for images), follow these steps for it.

Prerequisite#

You must have an account on Nitrogen
You must have access to your domain hosting portal (e.g. GoDaddy, Cloudflare), for domain ownership validation.

Steps#

Adding the domain#

Please first add the root/apex domain (e.g. nviztest.com), and then the subdomain (e.g. www.nviztest.com).

Adding new Users

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

This is to provide your account access to other users who can also manage your account. You can provide the user either view, edit or no access for your account, site and domains.

Prerequisite#

New user must be registered on N7.
If not, new user will receive an email invitation to the user over mail so they can register on N7.

Steps#

Click on your ACCOUNT name at top-right corner to open account-level features.

Bandwidth Consumption

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

This dashboard will show the Bandwidth details for the configured domains.
Click on Analytics menu, and select Bandwidth Consumption chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using nviztest.com site data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Charts#

Total Bandwidth: This chart shows the Bandwidth details.

CORS

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

This page will show you the options to configure CORS (Cross-Origin Resource Sharing) response headers for your site. Refer this MDN link for more details.

It is a mechanism that allows a server to indicate any origins (domain, scheme, or port) other than its own from which a browser should permit loading resources.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Security menu, and open CORS tab.

Country conditions

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

This page will show you steps to configure conditions based on country from where request is originated These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would want to set country based redirections.

Note: For demo purpose, we will be using www.nviztest.com domain as an example. Here, we will be redirecting all requests from US to /us/.*

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Settings menu, and open Country Conditions tab.

Dashboard

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

This page will give you idea of default RDX charts available, and steps to create custom dashboards and to add charts in them.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have RDX configured on your domain. If not, please refer this article for the same.

Sections#

Click on Dashboard menu. Then select appropriate domain from the domains dropdown.

Dashboard

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

This screen will display you various charts and cards with information related the selected domain e.g. Pre rendered pages, Search Bot Crawls etc.
Please go through below articles to get the details.

Cards#

Last Month’s, Current Month’s and Yesterday’s Data.

Charts#

List of History Execution URls#

This table will fetch the list of execution history with the status code

History

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

This screen will display you list of all the configuration versions pushed to live. You can deploy your current draft here, compare versions, or rollback to any previous version.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have an account on Nitrogen
You must have some domains registered on Nitrogen.
You must have some changes made/deployed.

Steps#

Select the respective Account and Domain from the dropdowns at the top right corner.

History

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

This screen will display you list of all the configuration versions pushed to live. You can deploy your current draft here, compare versions, or rollback to any previous version.
Please go through this article to get the details.

Human-Detector (HD): Integration steps

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

Integration on Website:#

Place the following script at the end of the <head> tag on all pages:
1. <script src="/n7/n7HD.js" type="text/javascript" async defer></script>

Integration on API/sub-domains#

If backend APIs are served from a different subdomain than the frontend application (for example: frontend on www.domain.com and APIs on api.domain.com), additional configuration is required for HD to function correctly.

Note: Please ensure that HD script is present on the primary domain.

Nitrogen Shift

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

Refer this page to configure redirections in bulk on your site using CSV import.
Typical use-case is, you would want to redirect multiple URLs at once due to a catalog update, or based on SEO-team recommendations.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Domains menu, then select Nitrogen Shift tab. Select appropriate domain from the domains dropdown.

Origins

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

This screen will show you list of endpoints configured for your domain.
Please go through this article to get the details.

Origins

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

This screen will show you list of endpoints configured for your domain.
Please go through this article to get the details.

Query Filters

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

Query parameter filters can be applied to URLs before matching against pre-rendered pages for domains that use the N7 DELIVERY module. Please deploy your domain using the History for these changes to take effect.

Follow these steps to configure Query Filter

NOTE: This section only for N7 clients, for non-N7 clients please refer the instructions

Prerequisite#

You must have a domain configured on Nitrogen.
You must have at least one page group created.
You must have Query Param created. If not, you can refer (Query Param ).

Steps#

Click on Rules section, then select Query Filters.

Query params

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

This page will show you steps to configure query-parameter based condition. These then can be used at Query Filters in Rules section.

Typical use-case is, you would want to cache and serve-from cache while ignoring the marketing/tracking query parameters (e.g. utm_*, fbclid, gclid etc.). Which will also create less cache-variations, and improve the cache-HIT percentage.

*Note: For demo purpose, we will be using example.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Settings menu, and open Query Params tab.

Request Caching

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

Refer this page to configure caching the responses. It will benefit you in improved response times, reduced load on your servers.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be setting 1 day caching TTL for homepage.

Prerequisite#

You must have a domain configured on Nitrogen.
For this example to work, you should have created URL pattern based condition for homepage ^/(\?.*)*$. If not set, you can refer this article for the same.

Steps#

Click on Caching menu, then select Request Caching tab. Select appropriate domain from the domains dropdown.

SERA Execution History

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

Get the details of the pages rendered during SERA execution for the selected page group.

You have access to last three SERA executions. Select the page group you want to see the history. You can select the relevent SERA execution from the last three run

Prerequisite#

You must have a domain configured on Nitrogen.
You must have at least one page group created. refer this article for page groups

Steps#

Click on Pages section, then select Sera Execution History.

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

Steps to test the website on Nitrogen without pointing the CNAME to Nitrogen

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

You can validate your website on Nitrogen by changing the host file entry; with which the traffic from your laptop will flow through the Nitrogen platform, while the rest of the world will continue to use the current live site.

Prerequisite#

You must have an account on Nitrogen
You must have some domain registered on Nitrogen.

Steps#

Please follow the steps shown in this link to do it as per the type of your system.

410 Responses

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

This topic is referenced in the imported documentation index, but the original Markdown page was not present in the MkDocs source bundle.

Replace this placeholder when the original 410 responses content is available.

Analytics

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

This screen will display you various charts with information related the selected domain e.g. Crawler Stats, Render Stats, Page Response Stats etc.
Please go through below articles to get the details.

Crawler Stats#

Render Stats#

Page Response Stats#

Cache Effectiveness

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

This dashboard will show the Cache HIT percentage data for the configured domains.
Click on Analytics menu, and select Cache Effectiveness chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using nviztest.com site data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Charts#

Cache Status: This chart shows the Cache HIT percentage for the overall requests.
HIT - Cached content being served form N7 CDN.
UNCACHEABLE - Requests set to not cache at N7 CDN.
MISS - Cacheable requests reached to the Origin to fetch the content.

CSP

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

This page will show you the step to configure CSP (Content-Security-Policy) response header for your site. Refer this MDN link for more details.

It allows website administrators to control resources the user agent is allowed to load for a given page. This helps guard against cross-site scripting attacks (Cross-site_scripting).

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Security menu, and open CSP tab.

Domains

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

This page will show you how can you configure a domain on RDX.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Sections#

Click on Domains menu. You will be shown a screen to set/unset RDX data collection, instructions to configure RDX on any domain, and adding new domain on RDX:

Last Event: When did the last data collection was done.

Domains listing page

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

This screen will give you clear and current status of all the domains that you have configured on Nitrogen.

Prerequisite#

You must have an account on Nitrogen
You must have some domains registered on Nitrogen.

Steps#

Click on your ACCOUNT name at top-right corner to open account-level features and then select DOMAINS tab. You will be shown a screen with list of all the domains registered on Nitrogen.

Header conditions

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

This page will show you steps to configure header based condition. These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would want to pass all requests from bots to https://prerender.io/ .
Here, we can achieve it by identifying all Bot requests by value of user-agent request header.

Note: Header conditions will work only on request-headers.
For demo purpose, we will be using www.nviztest.com domain as an example. Here, we will only be using googlebot and bingbot user-agent for simplicity.

History

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

History

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

Human-Detector (HD): Configuration Guide

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

Typical Use-Cases#

Account Pages
Cart Pages
Checkout Pages
Other sensitive Pages/APIs

Prerequisites#

A domain must be configured on Nitrogen.
Website or mobile app must integrate the HD script or token-fetching step.
URL pattern must be set for the desired pages (e.g., ^/cart(?.)$).

Configuration Steps#

Go to the Security menu and select the Human Detector tab.
Choose the domain from the dropdown list.

Maintenance page

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

Refer this page to show maintenance page to users. You can use during your deployment/infra-upgrade activities.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.
You must have a maintenance image/file uploaded on Nitrogen. Refer this article for the same.

Steps#

Click on Domains menu, then select Maintenance Page tab. Select appropriate domain from the domains dropdown.

Nitrogen Headers

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

Request headers#

Your server will receive following request headers from Nitrogen :

X-Nv-True-Client-Ip#

This request header contains the IP of user’s device.

X-Nv-Geo-Country#

This request header contains 2 letter standard country code of user’s request country.

X-Nv-Device#

This request header contains 2 letter device-type-code.

- `dt`: Desktop
- `sp`: SmartPhone
- `tb`: Tablet
- `st`: SmartTV
- `bt`: Bot
- `ot`: Other

X-Nv-Geo-Lat#

This request header latitude of user’s request location.

Nitrogen purge API

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

You can integrate purge API in your build script to purge the relevant/changed resource’s cache.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.
You must have caching configured. If not, you can refer this article for the same.
You must have a service account configured with Editor access. If not, you can refer this article for the same.

Steps#

This involves 2 steps: getting the list of all purge-groups, and then configuring the purge API for the required one.

Secret Token

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

Update your web server configuration to include the following header for authenticating requests routed to sera.n7.io If your domain is using the N7 DELIVERY module, this will be handled for you automatically.

NOTE: This section only for N7 clients, for non-N7 clients please refer the instructions to setup the secret token into your application

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:

Settings

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

This screen will show the concurrency and user-agent settings for the SERA process. User-Agent string is used while crawling the pages for SERA.

Note: Concurrency value must be within the range of 1 to 100.

URL patterns

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

This page will show you steps to configure request patterns. These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would want to proxy a set of URLs to a certain endpoint, or use in a certain condition group.

*Note: For demo purpose, we will be using example.com domain as an example.
Here, we will be defining a URL pattern for Non SERA requests patterns

User request flow through N7 to Origin

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

This diagram shows the flow of user requests through N7 to origin servers

Prerequisite#

You must have domain configured on Nitrogen.

Details#

Here, when the request is made from user device, the DNS resolves it to Nitrogen.
If the response for this request is cached at Nitrogen CDN (at the CDN PoP near to user), it is returned back to user from there itself.
Else, the request is proxied to Origin. The response is then optimized by the respective modules if enabled e.g. images by AIO, videos by AVO.
(If WAF is opted, the request is terminated their itself if deemed malicious by it.)

DoS Attacks

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

This dashboard will show the top input traffic details and the blocked requests count at N7 WAF for the configured domains.
Click on Analytics menu, and select DoS Attacks chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using nviztest.com site data as an example.

HSTS

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

This page will show you steps to configure HSTS (Strict-Transport-Security) response header for your site. Refer this MDN link for more details.

HSTS response header informs browsers that the site should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS.

When a browser knows that a domain has enabled HSTS, it does two things:

Always uses an https:// connection, even when clicking on an http:// link or after typing a domain into the location bar without specifying a protocol.
Removes the ability for users to click through warnings about invalid certificates.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Image Config

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

Refer this page to provide the image URL pattern that will be processed by AIO.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Domains menu, then select Image Config tab.
Request Pattern: Select the URL pattern for Images from the dropdown.
if the default URL pattern is not suitable to your case, you can create your own by following these steps .

IP Addresses

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

This page will show you steps to configure conditions based on request IP. These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would want to block the IPs you found making malicious requests to your site.

Note: For demo purpose, we will be using www.nviztest.com domain as an example. Here, we will be blocking all requests from a blacklisted IP.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Settings menu, and open IP Addresses tab.

Log-Extracts

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

This is to provide the access logs of requests received for your domains at Nitrogen Edge servers. You can apply filters and get the logs for a specific domain(s) for the required timeframe.

Steps#

Click on your ACCOUNT name at top-right corner to open account-level features.
Click on Logs Extracts. “Refresh” - To update the requested logs status as it will take some time to process once requested.
Click on “New log Extraction Request” to initiate the log request.

N7 Support Severity Prioritization Matrix and Response TAT

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

For any technical issues/support, please send mail to support@n7.io
The Nitrogen care team continuously monitors your website for any issues, and sends alerts for any exceptional scenario observed.
Please mark e-mails from support@n7.io as not junk, and add the address to the safe-senders list.

Prerequisite#

You must have an account on Nitrogen

Details#

Nitrogen Headers

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

Refer this page to change the Nitrogen header names to the ones used in your code using. This feature is useful when you are migrating to Nitrogen from similar service, and are using these headers.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen

Steps#

Click on Domains menu, then select Nitrogen Headers tab.

Origins

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

This screen will show you list of endpoints configured for your domain.

Typical use case with multiple origins is setting up proxies to different servers based on URL pattern
e.g. API / static-assets / admin / CMS / pre-render etc.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have an account on Nitrogen
You must have some domain registered on Nitrogen.

Steps#

Select the respective Account and Domain from the dropdowns at the top right corner.

Purge logs

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

You can see here the logs of the purge activity by your team.
This can also help you in identifying sudden increase in requests if purge was performed.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.
You should have caching configured. If not, you can refer this article for the same.
You should have performed purge. If not, you can refer this article for the same.

Steps#

Click on Caching menu, then select Purge Logs tab. Select appropriate domain from the domains dropdown.

RDX Settings

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

This page will show you how can you change the RDX settings

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have RDX configured on your domain. If not, please refer this article for the same.

Sections#

Click on RDX Settings menu. Then select appropriate domain from the domains dropdown. You will be shown following sections:

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 Render API

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

An on-demand API can be used to submit page URLs to SERA for rendering, allowing you to integrate with tools and automatically render frequently updated sites via scripts or tools.

Prerequisite#

You must have an account on Nitrogen.
Your target domain on which you want to call SERA on demand api must have been registered on Nitrogen.
You must have a service account configured with Editor access. If not, you can refer this article for the same.

Render API Request#

Render API Request Details#

API :

Video Routing

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

Here you specify the path from where the videos will be served.

For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have your domain registered on Nitrogen.
You must have AVO enabled on your domain. Refer this article if not done.
You must have a created a URL pattern for videos. If you have not, please refer this article .

Steps#

Click on AVO module.

Analytics

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

This screen will display you various charts with information related the selected domain e.g. errors/caching/bandwidth etc.
Please go through below articles to get the details.

AVO processing steps

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

Below are the stesps to process/optimize the videos using N7 AVO.

For demo purpose, we will be using www.nviztest.com domain as an example.
We will process a video from source-domain (static.nviztest.com):
e.g. https://static.nviztest.com/videos/vid101.mp4
After processing, it will then be accessible on target-domain (www.nviztest.com ) with the same path as source:
i.e. https://www.nviztest.com/videos/vid101.mp4

Prerequisite#

You must have an account on Nitrogen.
Your target domain on which you want to configure AVO must have been registered on Nitrogen.

Change Log

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

This is to check your account activity.

Steps#

Click on your ACCOUNT name at top-right corner to open account-level features.
Click on Change Log. Click on calender icons to select the ‘start date/time’ and ’end date/time’ and click on ‘Retrieve’.
You will now see the change logs of your account. Note: You can use filters as shown in below screenshot.

Delete SERA Render Storage API

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

This API enables you to purge cached renders and delete SERA-rendered pages associated with a specific URL. It is particularly useful when a page has been removed and its rendered artifacts need to be cleaned up.

Prerequisite#

You must have an account on Nitrogen.
Your target domain must have been registered on Nitrogen.
You must have a service account configured with Editor access. If not, you can refer this article for the same.

Delete Render Storage API Request#

Delete Render Storage API Request Details#

API :

HTTP methods

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

Here, you will find steps to configure conditions based on request method. These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would want to block TRACE, PATCH, CONNECT methods for security purpose.

Note: For demo purpose, we will be using www.nviztest.com domain as an example. Here, we will be creating method-group of TRACE, PATCH, CONNECT methods to block them.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Settings menu, and open HTTP Methods tab.

Human Detector

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

This dashboard will show you Analytic data for Human Detector.
Click on Analytics menu, and select Human Detector chart for it.

Note: For demo purpose, we will be using www.nviztest.com domain data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.
For this example to work, you should have Human-Detector enabled on the domain. If not set, you can refer this article for the same.

Charts#

Actions Taken: This chart shows per day count of occurrences per HD block mode.

Optimization

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

Here you can set the quality parameters based on network, screen and computer power.

For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have your domain registered on Nitrogen.
You must have AIO enabled on your domain. Refer this article if not done already.
You must have enabled Image Resizing in Image Config. Refer this article for it.

Steps#

Edit the default image optimization quality values as per your requirement.
You can enable/disable the variant creation for a specific image type by toggling the support switch above the quality table.

Origins

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

This screen will show you list of endpoints configured for your domain.
Please go through this article to get the details.

Purge cache

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

Please follow these steps to purge Nitrogen cache for the required resources.

*Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.
You should have caching configured. If not, you can refer this article for the same.

Steps#

Click on Caching menu, then select Purge Cache tab. Select appropriate domain from the domains dropdown.

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.

Whitelisting Nitrogen CDN Requests

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

To ensure your servers accept traffic from Nitrogen, you must whitelist our requests. We strongly recommend whitelisting by request header, as it provides a more secure and flexible setup.
For maximum security, you should configure your servers to allow traffic only from Nitrogen.

Whitelist by Request Header (Recommended)#

Configure your firewall or load balancer to allow incoming requests that contain one of the following HTTP headers.

XSS

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

This page will show you the options to configure XSS (Cross-Site-Scripting) response headers for your site.

Cross-site scripting (XSS) is a security exploit which allows an attacker to inject into a website malicious client-side code. These attacks succeed if the Web app does not employ enough validation or encoding. Refer this MDN link for more details.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Steps#

Click on Security menu, and open XSS tab.

AIO Parameters

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

Refer this page to instruct AIO to resize/crop/merge the image based on the value provided in querystring.

Note: For demo purpose, we will be using www.n7.io domain as an example.

Prerequisite#

You must have a domain configured on Nitrogen
You must have AIO enabled, please refer this article .

You can add the following query parameters in the image URL to scale the image based on width/height, to crop, to cut, to merge, or to serve original image without optimizing it:

Analytics API

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

This API provides daily requests, bandwidth usage metrics for a specified domain. It helps users monitor and analyze requests, bandwidth consumption to gain insights into network performance.

Prerequisite#

You must have an account on Nitrogen.
Your target domain on which you want to get bandwith or requests, must have been registered on Nitrogen.
You must have a service account configured with Editor access. If not, you can refer this article for the same.

API Request & Response#

Endpoint#

POST https://dash.n7.io/api/v2/sense/metric/bandwidth

Overview of Video Catalog

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

Here you can find all variations of the optimized videos.

For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have your domain registered on Nitrogen.
You must have AVO enabled on your domain. Refer this article if not done.

Steps#

1.Click on video catalog menu.

2.Select appropriate domain from the domains dropdown at top right corner.

3.Here you can find all variations of the optimized videos by typing the necessary video name into the search bar.

Query params

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

This page will show you steps to configure query-parameter based condition. These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would want to cache and serve-from cache while ignoring the marketing/tracking query parameters (e.g. utm_*, fbclid, gclid etc.). Which will also create less cache-variations, and improve the cache-HIT percentage.

Note: For demo purpose, we will be using www.nviztest.com domain as an example. Here, we will create a query-param condition with regex pattern (utm_|fbclid|gclid) to be used to ignore them while caching/serving-from-cache.

Security Rate-Limit scenarios

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

The following scenarios describe how rate limits are enforced for incoming requests.

Prerequisite#

The Security module must be opted in and enabled for your domain.

Details#

They illustrate system behavior when a ban is not enabled (soft limit) versus when a ban is triggered (hard limit).

Scenario 1: Soft Rate Limit (No Ban)#

Policy Example: Limit of X requests per Y minutes per IP
Behavior:
1. Requests are tracked in a rolling time window (e.g., 60 minutes).
2. Up to X requests from a single IP are allowed during the window.
3. Any request exceeding the limit results in a 429 Too Many Requests response.
4. No ban is imposed — the IP is not blocked.
5. As older requests fall out of the time window, new requests are allowed again.
Flow Example:
1. Time 00:00 – 1st request ➜ Allowed
2. Time 00:45 – Xth request ➜ Allowed
3. Time 00:46 – X+1th request ➜ 429
4. Time 01:01 – Oldest request expires ➜ 1 new request allowed

Scenario 2: Hard Rate Limit (with Ban)#

Policy Example: Limit of X requests per Y minutes per IP ➜ Temporary ban (e.g., 15 minutes) if exceeded

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.

Image-Catalog

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

Here you can find all variations of the optimized images.

For demo purpose, we will be using www.nviztest.com domain as an example.

Prerequisite#

You must have your domain registered on Nitrogen.
You must have AIO enabled on your domain. Refer this article if not done already.

Steps#

Click on Image catalog menu and select appropriate domain from the domains dropdown at top right corner.

Missing Assets

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

This dashboard will show the 404 status code request details for the configured domains.
Click on Analytics menu, and select Missing Assets chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using nviztest.com site data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Charts#

Page Not Found - 404 Request: This chart shows the count of 404 status code requests.

Reordering rules

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

Using the steps given here, you can order the configured rules.
This is important as, Nitrogen matches the rules in the provided order. And, the first matched rule is applied.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be moving proxy everything else to n7- rule at the end. So that, it will match to all the requests that did not match other URL-specific proxy rules.

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 Scenarios

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

This document specifies scenarios that can affect the bot results.

Prerequisite#

Your must have a domain on which SERA is configured.
You must have an account on Nitrogen to view the dashboard.

SERA workflow#

SERA (Search Engine Rank Accelerator) is a tool that serves the ‘optimized’ version of ‘pre-processed’ page to the bots.
As bots need less time to process and render the SERA pages, they provide a good CWV score to the pages, and also effectively utilize the crawl budget.
All the render and crawl related stats can be checked in Dash .
To process the pages, SERA uses :

Steps to use WPT to analyze the site performance

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

Nitrogen recommends using https://www.webpagetest.org/ (WPT for short) for measuring and comparing the performance of any website.
Because it’s easy to use, and has variety of options available like :
e.g. test location, connection speed, browser to be used, test device, DNS overriding ability, filmstrip of page load, CWV data, test comparisons, and many more things.

Prerequisite#

If you are analyzing performance through Nitrogen :

You must have an account on Nitrogen

URL patterns

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

This page will show you steps to configure request patterns. These then can be used at multiple places such as rewrite/caching/blocking rules.

Typical use-case is, you would want to proxy a set of URLs to a certain endpoint, and then set caching specific to it.
e.g. You can proxy image requests to your static domain, and set 90 days caching for them. (This way also helps avoiding extra OPTIONS calls made by browser for the request being for other domain)

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be defining a URL pattern for relative requests of global-uploads.webflow.com domain - to proxy them to that domain itself.

Analytics

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

This dashboard will show the 4xx status code data for the configured domains.

Note: For demo purpose, we will be using nviztest.com site data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.
You must have AIO enabled on your domain. Refer this article if not done already.

Charts#

Click on Analytics, you will see following charts:

Total saving: Total bandwidth saved by AIO for all the domains in the current site together.

Rewrites

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

Refer this page to configure proxies for your domain requests. This feature is useful when you wish to keep request URL same but change the underlying handling endpoint.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be rewriting all requests to add n7- as a prefix before sending them to server, and for homepage we will add n7 as a prefix

Security

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

This dashboard will show you Analytic data for blocked requests for the N7 WAF enabled domains. Please contact us if you wish to configure it.
Click on Analytics menu, and select Security chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using www.nviztest.com domain data as an example.

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.

Integration on Mobile app

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

This documentation explains which Accept Headers needs to be included for Images in Mobile App. This allows you to optimize images specifically for Nitrogen AIO delivery.

Prerequisites#

You must have a domain configured on Nitrogen
You must have AIO enabled, please refer this article .
Basic understanding of Mobile App Image Properties and Nitrogen AIO.

Steps#

Add the following mandatory Headers on outgoing image requests. Please modify the values based on the user’s mobile device and network configuration:

Integration on Next JS

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

This documentation explains how to create a custom image loader in Next.js to modify image URLs for the Nitrogen AIO. This allows you to optimize images specifically for Nitrogen AIO delivery.

Prerequisites#

You must have a domain configured on Nitrogen
You must have AIO enabled, please refer this article .
Basic understanding of Next.js and Nitrogen AIO.
Node.js and npm (or yarn) installed on your development machine.

Steps#

Install package :

Integration on Shopify

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

This documentation explains how to update Shopify end configuration to proxy image requests to N7 AIO.

Prerequisites#

You should have access to Shopify admin portal (admin.shopify.com )
You should have a Nitrogen AIO endpoint available. If you have not received it - check with the Nitrogen POC person in contact with you, OR mail to support@n7.io .

Steps#

Creating AIO settings
1. Open https://admin.shopify.com/
2. Go to Sales channels > Online store themes > Themes menu from left side.
  Edit code for your current theme by clicking on ... menu and then clicking Edit code menu.
3. Select config folder and then open settings_schema.json file.
  Then add our AIO setting from this file
4. Now select Snippets folder, and copy aio.liquid and aio-image.liquid files to it.
Configuring AIO

Static Pages

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

Refer this page to serve static files from Nitrogen itself. You can use it for serving resources like robots.txt, maintenance page, logo etc.

Note: For demo purpose, we will be using www.nviztest.com domain as an example.
Here, we will be setting desktop and mobile WPTs for homepage.

Prerequisite#

You must have a domain configured on Nitrogen

Steps#

Click on Domains menu, then select Static Pages tab. Select appropriate domain from the domains dropdown.

Traffic Pattern Summary

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

This dashboard will show the input traffic details for the configured domains.
Click on Analytics menu, and select Traffic Pattern Summary chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using nviztest.com site data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Charts#

Countries: This chart shows the percentage traffic received from different countries.

All Articles 📖

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

Nitrogen
- Nitrogen request/response headers
- Whitelisting Nitrogen CDN Requests
Account
- Overview
- Domains listing
- Log extracts
- Change log
- Analytics dashboard
- Users
  - Create users
  - Create API keys
Delivery
- Routing
  - DNS
  - Origins
  - History
  - Rewrites
    - Create rewrite rules
    - Reorder rules
  - Creating condition patterns
  - Redirects
    - Priority redirections
    - Bulk redirections
  - Static content
  - Maintenance Page
  - Nitrogen Headers
- Caching
- Security
  - Conditional request blocking
  - Human Detector
  - Fly Auth
  - Security headers
    - HSTS
    - XSS
    - CSP
    - CORS
- Analytics dashboard
AIO
AVO
RDX
- Overview
- Dashboard
- Domains
- Settings
SERA
- Configure SERA through Dash
- Configure SERA at server end
- Dashboard
- Analytics
- Run SERA on ad-hoc basis
- Pages
- Rules
- Settings
Miscellaneous
- Steps to test the website on Nitrogen without pointing the CNAME to Nitrogen
- Steps to use WPT to analyze the site performance

N7 Storage

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

N7 Storage provides an on-demand API to upload files, allowing seamless access to those resources via your registered domain.

Prerequisite#

You must have an active account on Nitrogen.
Your target domain, where files will be uploaded and accessed, must be registered on Nitrogen.
A service account with Editor access must be configured. If you don’t have one, refer to this article to create API keys.

API: Upload Files to N7 Storage#

API :

Unplanned Outage

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

This dashboard will show the 5xx status code data for the configured domains.
Click on Analytics menu, and select Unplanned Outage chart for it.
If no domain is selected, the charts will show data of all domains configured on current account. Else data will be displayed for selected domain.

Note: For demo purpose, we will be using nviztest.com site data as an example.

Prerequisite#

You must have a domain configured on Nitrogen.

Charts#

Unserved Requests Percentage: This chart shows the percentage of the HTTP status code of the 5xx error requests.

Nitrogen Support

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

You can raise any doubts/issues to support@n7.io .

Also, you can raise your query from dash by following these steps:

Click on Settings icon next to your user-name at top right corner. And select Support
Provide the required details, and click on Submit button. Our support team will receive your request and get back to you.

Notes#

Changes to provide attachments in ticket are in progress, and will be released soon.