Installation and Initialization
This guide explains the installation and initialization process for the NetFUNNEL Akamai agent.
Step 1: Get Client ID
- Go to NetFUNNEL Console
- Click the profile icon in the top right corner
- Select the
Integration Credentialsmenu - 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
- Akamai Console → Click [EdgeWorkers] menu
- Click [Create EdgeWorker ID]
- Enter details and click [Create EdgeWorker ID] to create EdgeWorker
- Select the created EdgeWorker and click [Create version]
- Click [Open editor]
Upload Agent Code
- Download
netfunnel-akamai-agent.jsfile from https://agent-lib.stclab.com/agents/cdn/akamai/netfunnel-akamai-agent-latest.js - Select
main.jsfile in [Code Bundle] tab - Paste the contents of
netfunnel-akamai-agent.jsfile - Select
bundle.jsonfile and write the following code:
{
"edgeworker-version": "1.0.0",
"description" : "akamai-agent-1.0.0"
}
- Click [Create new version] to create version
Deploy EdgeWorker
- Click [Activate version]
- Select [Production] and click [Activate version] to deploy
- 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.
- Click [Properties] menu
- Click [New Property]
- Click [Create Property]
- Click [Guide me]
- Enter details and click [Next] button
- Check Hostname value and click [Next] button
- STEP1: Enter details, click [Validate], select EDGE CERTIFICATE
- Click [Continue], configure cache, then click [Next]
- STEP2: Click [Next]
- STEP3: Click [Activate], after completion click [Next]
- STEP4: Click [Next]
- STEP5: Click [Exit] to complete Property creation
Step 4: Configure Property
Select Property
- Click [Properties] menu
- Select the created Property
- Select the version to modify (the version at the top)
Configure Property Variables
Add Property Variables referring to the table below.
| VARIABLE NAME | INITIAL VALUE |
|---|---|
NF_CLIENT_ID | {{CLIENT_ID}} |
Check CLIENT_ID in the NetFUNNEL console.
Configure Property Configuration Settings
Add EdgeWorker Rule
- Click [+Rules] in Property Configuration Settings
- Select [Blank Rule Template] and enter "NF EdgeWorker"
- Click [Insert Rule]
- Click [+Match] in Criteria:
- Path:
matches one of→/*
- Path:
- 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
- File Extension:
- Click [+Behavior] in Behaviors → Select Standard property behavior
- Select EdgeWorkers and click [Insert Behavior]
- Select the created EdgeWorker in Identifier
Add Core Origin Rule
- Click [+Rules]
- Select [Blank Rule Template] and enter "NF Core Origin"
- Click [Insert Rule]
- Click [+Match] in Criteria:
- Path:
matches one of→/ts.wseq
- Path:
- Click [+Behavior] in Behaviors → Select Standard property behavior
- Select Origin Server and click [Insert Behavior]
- Configure referring to the table below:
| Item | Value |
|---|---|
| Origin Type | Your Origin |
| Origin Server Hostname | {CLIENT_ID}.netfunnel.stclab.com (e.g., stclab-0601.netfunnel.stclab.com) |
| Forward Host Header | Origin Hostname |
| Cache Key Hostname | Origin Hostname |
Add Setting Origin Rule
- Click [+Rules]
- Select [Blank Rule Template] and enter "NF Setting Origin"
- Click [Insert Rule]
- Click [+Match] in Criteria:
- Path:
matches one of→ Path of{{NF_SETTING_URL}}(e.g.,/stclab-0601.netfunnel/nf-setting.json)
- Path:
- Click [+Behavior] in Behaviors → Select Standard property behavior
- Select Origin Server and click [Insert Behavior]
- Configure referring to the table below:
| Item | Value |
|---|---|
| Origin Type | Your Origin |
| Origin Server Hostname | nf-setting-bucket.stclab.com |
| Forward Host Header | Origin Hostname |
| Cache Key Hostname | Origin Hostname |
Step 5: Save and Activate Property
- Click [Save] button at the bottom right
- Click [Activate] tab at the top
- Click [Activate
{version}on Production] in Production Network - After Verifying is complete, check the warning message box at the top
- Click [Activate
{version}on Production] - After completion, Property activation is complete
Next Steps
- Initialization Settings: Property Variables and additional feature configuration
- Troubleshooting: Common issues and solutions