Skip to main content
Version: 4.6.1-saas

Quick Start

Get started with NetFUNNEL 4 Akamai Agent in 5-10 minutes with this quick start guide.

Prerequisites​

  • NetFUNNEL console access
  • Akamai account with EdgeWorker support
  • Permission to create and manage Property

Step 1: Get Client ID​

  1. Go to NetFUNNEL Console
  2. Click the profile icon in the top right corner
  3. Select the Integration Credentials menu
  4. Copy Client ID

Step 2: Create EdgeWorker​

  1. Akamai Console → Click [EdgeWorkers] menu
  2. Click [Create EdgeWorker ID]
  3. Enter details and click [Create EdgeWorker ID] to create EdgeWorker
  4. Select the created EdgeWorker and click [Create version]
  5. Click [Open editor]

Step 3: Upload Agent Code​

  1. Download netfunnel-akamai-agent.js file from https://agent-lib.stclab.com/agents/cdn/akamai/netfunnel-akamai-agent-latest.js
  2. Select main.js file in [Code Bundle] tab
  3. Paste the contents of netfunnel-akamai-agent.js file
  4. Select bundle.json file and write the following code:
{
    "edgeworker-version": "1.0.0",
    "description" : "akamai-agent-1.0.0"
}
  1. Click [Create new version] to create version
  2. Click [Activate version]
  3. Select [Production] and click [Activate version] to deploy

Step 4: Configure Property​

Configure Property Variables​

  1. Click [Properties] menu
  2. Select Property (create if it doesn't exist)
  3. Select the version to modify
  4. Add the following to Property Variables:
VARIABLE NAMEINITIAL VALUE
NF_CLIENT_ID{{CLIENT_ID}}

Add EdgeWorker Rule​

  1. Click [+Rules] in Property Configuration Settings
  2. Select [Blank Rule Template] and enter "NF EdgeWorker"
  3. Click [Insert Rule]
  4. Click [+Match] in Criteria:
    • Path: matches one of → /*
  5. Add [+Match]:
    • File Extension: is not one of → Exclude HTML files, exclude static file extensions
  6. Click [+Behavior] in Behaviors → Select EdgeWorkers
  7. Click [Insert Behavior]
  8. Select the created EdgeWorker in Identifier

Add Core Origin Rule​

  1. Click [+Rules]
  2. Select [Blank Rule Template] and enter "NF Core Origin"
  3. Click [Insert Rule]
  4. Click [+Match] in Criteria:
    • Path: matches one of → /ts.wseq
  5. Click [+Behavior] in Behaviors → Select Origin Server
  6. Click [Insert Behavior]
  7. Configure:
    • Origin Type: Your Origin
    • Origin Server Hostname: {CLIENT_ID}.netfunnel.stclab.com
    • Forward Host Header: Origin Hostname
    • Cache Key Hostname: Origin Hostname

Add Setting Origin Rule​

  1. Click [+Rules]
  2. Select [Blank Rule Template] and enter "NF Setting Origin"
  3. Click [Insert Rule]
  4. Click [+Match] in Criteria:
    • Path: matches one of → Path of {{NF_SETTING_URL}} (e.g., /stclab-0601.netfunnel/nf-setting.json)
  5. Click [+Behavior] in Behaviors → Select Origin Server
  6. Click [Insert Behavior]
  7. Configure:
    • Origin Type: Your Origin
    • Origin Server Hostname: nf-setting-bucket.stclab.com
    • Forward Host Header: Origin Hostname
    • Cache Key Hostname: Origin Hostname

Step 5: Activate Property​

  1. Click [Save] button at the bottom right
  2. Click [Activate] tab at the top
  3. Click [Activate {version} on Production] in Production Network
  4. After Verifying is complete, check the warning message box
  5. Click [Activate {version} on Production]

Next Steps​