Skip to main content
Version: 4.6.1-saas

Initialization Settings

This document explains Lambda config settings and additional features available in NetFUNNEL CloudFront Agent.

Lambda Config Settings​

Control the behavior of the NetFUNNEL agent through the config object in the Lambda function's index.mjs file.

Required Settings​

clientID​

Enter the client ID issued from the NetFUNNEL console.

const config = {
  clientID: "{{CLIENT_ID}}",
}

Configuration steps:

  1. Open index.mjs file in Lambda function
  2. Enter Client ID from NetFUNNEL console in clientID of config object
  3. Click [Deploy] button
  4. [Versions] tab → Click [Publish new version]
  5. Update Lambda function version in CloudFront and perform invalidation

Additional Features​

Good Bot Exception Handling​

You can exclude specific User-Agent values from agent behavior through Lambda settings.

Lambda Configuration​

const config = {
  clientID: "{{CLIENT_ID}}",
  goodBots: ["Googlebot", "Bingbot", "Slurp", "Applebot", "facebookexternalhit"],
}

Example: Example code that excludes Google, Microsoft, Yahoo, Apple, and Facebook bots.

Configuration steps:

  1. Open index.mjs file in Lambda function
  2. Add User-Agents of good bots to exclude as an array in goodBots of config object
  3. Click [Deploy] button
  4. [Versions] tab → Click [Publish new version]
  5. Configure CloudFront and perform invalidation

CloudFront Configuration​

  1. Select CloudFront Distribution with Lambda@Edge applied
  2. Select an item in [Behaviors] tab and click [Edit]
  3. Update viewer request and viewer response to new version in Function associations at the bottom
  4. Click [Save changes]

CloudFront Invalidation​

  1. Click [Invalidations] tab
  2. Click [Create invalidation]
  3. Object paths: Enter /*
  4. Click [Create invalidation]

Entry Key Automatic Return Processing​

NetFUNNEL CloudFront agent automatically returns the NetFUNNEL key after entry to allow the next person in queue to enter. This feature can be used when you want to return the NetFUNNEL key at the timeout time set in the segment instead of returning it immediately.

Lambda Configuration​

const config = {
  clientID: "{{CLIENT_ID}}",
  returnKey: true,
}
  • true (default): The agent automatically returns the NetFUNNEL key after waiting is complete and entry.
  • false: The key is returned at the timeout time set in the segment.

Configuration steps:

  1. Open index.mjs file in Lambda function
  2. Enter true or false in returnKey of config object
  3. Click [Deploy] button
  4. [Versions] tab → Click [Publish new version]
  5. Configure CloudFront and perform invalidation

CloudFront Configuration​

  1. Select CloudFront Distribution with Lambda@Edge applied
  2. Select an item in [Behaviors] tab and click [Edit]
  3. Update viewer request and viewer response to new version in Function associations at the bottom
  4. Click [Save changes]

CloudFront Invalidation​

  1. Click [Invalidations] tab
  2. Click [Create invalidation]
  3. Object paths: Enter /*
  4. Click [Create invalidation]

Waiting Room Domain Change​

The domain of the NetFUNNEL waiting room page is agent-lib.stclab.com. To change this domain to match your service domain, contact the NetFUNNEL service team with your desired domain and change the Lambda settings.

Lambda Configuration​

const config = {
  clientID: "{{CLIENT_ID}}",
  vwrPageDomain: "https://wait.stclab.com",
}

Example: Example code that changes the waiting room domain to wait.stclab.com.

Configuration steps:

  1. Open Lambda function applied to viewer-request
  2. Open index.mjs file
  3. Enter the waiting room address you want to change in vwrPageDomain of config object
  4. Click [Deploy] button
  5. [Versions] tab → Click [Publish new version]
  6. Configure CloudFront and perform invalidation

CloudFront Configuration​

  1. Select CloudFront Distribution with Lambda@Edge applied
  2. Select an item in [Behaviors] tab and click [Edit]
  3. Update viewer request and viewer response to new version in Function associations at the bottom
  4. Click [Save changes]

CloudFront Invalidation​

  1. Click [Invalidations] tab
  2. Click [Create invalidation]
  3. Object paths: Enter /*
  4. Click [Create invalidation]

When storing keys issued by the NetFUNNEL server in cookies, they are stored based on the current page's domain. If you need to share keys between different subdomains, configure it so that the main domain is stored in cookies.

Example: Set to .stclab.com so that cookies are shared between pages with different subdomains such as develop.stclab.com and staging.stclab.com.

Lambda Configuration​

const config = {
  clientID: "{{CLIENT_ID}}",
  cookieDomain: ".stclab.com",
}

Example: Example code that changes the cookie domain to .stclab.com.

Configuration steps:

  1. Open Lambda function applied to viewer-request
  2. Open index.mjs file
  3. Enter in .MAIN_DOMAIN format in cookieDomain of config object
  4. Click [Deploy] button
  5. [Versions] tab → Click [Publish new version]
  6. Configure CloudFront and perform invalidation

CloudFront Configuration​

  1. Select CloudFront Distribution with Lambda@Edge applied
  2. Select an item in [Behaviors] tab and click [Edit]
  3. Update viewer request and viewer response to new version in Function associations at the bottom
  4. Click [Save changes]

CloudFront Invalidation​

  1. Click [Invalidations] tab
  2. Click [Create invalidation]
  3. Object paths: Enter /*
  4. Click [Create invalidation]

Lambda Function Deployment and CloudFront Invalidation​

After changing Lambda config, you must perform the following steps for the changes to take effect.

  1. Click [Deploy] button in Lambda function
  2. [Versions] tab → Click [Publish new version]
  3. Update Lambda function version in CloudFront Distribution
  4. Perform CloudFront invalidation