Skip to main content
Version: 4.6.1-saas

Installation and Initialization

This guide explains the installation and initialization process for the NetFUNNEL Akamai agent.


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
Client ID Location

You can find it in the Integration Credentials menu after clicking the profile icon in the top right corner of the console screen.


Step 2: Create EdgeWorker

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]

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

Deploy EdgeWorker

  1. Click [Activate version]
  2. Select [Production] and click [Activate version] to deploy
  3. After deployment is complete, when Current Status becomes Complete, it is done

Step 3: Create Property (Optional)

If you already have a created Property, proceed to the next step.

  1. Click [Properties] menu
  2. Click [New Property]
  3. Click [Create Property]
  4. Click [Guide me]
  5. Enter details and click [Next] button
  6. Check Hostname value and click [Next] button
  7. STEP1: Enter details, click [Validate], select EDGE CERTIFICATE
  8. Click [Continue], configure cache, then click [Next]
  9. STEP2: Click [Next]
  10. STEP3: Click [Activate], after completion click [Next]
  11. STEP4: Click [Next]
  12. STEP5: Click [Exit] to complete Property creation

Step 4: Configure Property

Select Property

  1. Click [Properties] menu
  2. Select the created Property
  3. Select the version to modify (the version at the top)

Configure Property Variables

Add Property Variables referring to the table below.

VARIABLE NAMEINITIAL VALUE
NF_CLIENT_ID{{CLIENT_ID}}

Check CLIENT_ID in the NetFUNNEL console.

Configure Property Configuration Settings

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
    • Extensions to exclude: woff, woff2, ttf, eot, otf, sfnt, svg, webp, avif, map, mp4, webm, ogg, ogv, flac, acc, docx, xls, xlsx, ppt, pptx, csv, xml, json
  6. Click [+Behavior] in Behaviors → Select Standard property behavior
  7. Select EdgeWorkers and 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 Standard property behavior
  6. Select Origin Server and click [Insert Behavior]
  7. Configure referring to the table below:
ItemValue
Origin TypeYour Origin
Origin Server Hostname{CLIENT_ID}.netfunnel.stclab.com (e.g., stclab-0601.netfunnel.stclab.com)
Forward Host HeaderOrigin Hostname
Cache Key HostnameOrigin 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 Standard property behavior
  6. Select Origin Server and click [Insert Behavior]
  7. Configure referring to the table below:
ItemValue
Origin TypeYour Origin
Origin Server Hostnamenf-setting-bucket.stclab.com
Forward Host HeaderOrigin Hostname
Cache Key HostnameOrigin Hostname

Step 5: Save and 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 at the top
  5. Click [Activate {version} on Production]
  6. After completion, Property activation is complete

Next Steps