Redirect pages based on location

In this tutorial you'll learn how to create an EdgeWorkers function that provides a customized user experience. Using less than 35 lines of code and EdgeScape geo data you can redirect web-site visitors to country specific content.

This example invokes an EdgeWorkers script at the onClientRequest phase of an HTTP request as the first event before caching occurs. Then, based on the request's country of origin, the response redirects users to location specific content.

ūüďė

You can find the redirect-geo code sample in the EdgeWorkers examples GitHub repo.

Before you begin

Before you can configure your EdgeWorkers function, you need to do a few things:

  • Get access to the EdgeWorkers interface in ‚ÄčAkamai Control Center‚Äč. This interface lets you perform the administrative tasks required to execute EdgeWorkers functions. You need to have a ‚ÄčControl Center‚Äč account that's been granted access to the EdgeWorkers Management application. If you're not sure, talk to your local ‚ÄčAkamai‚Äč admin, or contact your ‚ÄčAkamai‚Äč account team.

  • Add EdgeWorkers to your contract. If you have an active ‚ÄčAkamai‚Äč contract and login credentials for ‚ÄčAkamai Control Center‚Äč you can sign up for the EdgeWorkers Evaluation tier. The Evaluation tier lets you try EdgeWorkers for free and without a time limit. If you're not already an ‚ÄčAkamai‚Äč customer or you don't have access to ‚ÄčAkamai Control Center‚Äč you can sign up for an EdgeWorkers free trial.

1. Create an EdgeWorker ID

An EdgeWorker ID lets you enable the EdgeWorkers behavior in Akamai‚Äč Control Center. It's also a unique identifier for your EdgeWorkers code.

  1. Log in to ‚ÄčControl Center‚Äč.

  2. Go to ‚ėį > CDN > EdgeWorkers.

  3. Click Create EdgeWorker ID.

    You cannot edit this auto-generated, unique identifier.

Create EdgeWorkers ID
  1. Enter Geolocation redirect as the name for the EdgeWorker ID.

  2. Select a Group Association.

    You can select only a group that you have permission to access.

  3. Select a Contract ID to associate with the EdgeWorker ID.
    The available resource tiers are filtered based on the contract ID you select.

ūüďė

The Contract ID field only appears if you have more than one contract ID associated with your account.

  1. Select a resource tier.

    EdgeWorkers resource tiers currently include and Dynamic Compute and Basic Compute.

    The limits for each resource tier are different. You can view the limits for the selected resource tier in the details section or you can view the Resource tier limitations section.

  2. Click Create EdgeWorker ID.

2. Add the EdgeWorkers behavior

When you add the EdgeWorkers behavior in Property Manager you can also define which requests apply EdgeWorkers functions. By limiting the scope you can avoid unnecessary serverless hits to improve performance and reduce cost.

  1. Navigate to your property in ‚ÄčControl Center‚Äč.

  2. Click Edit.

  3. Click + Rules.

  1. Enter a name for your rule and click the Insert Rule button.

  2. Click the + Match button to add a match criteria and scope.

    The criteria below only executes the EdgeWorkers function when the path matches locationBasedRedirect.

Add EdgeWorkers behavior
  1. Next, click the + Behavior button and select standard property behavior,
  2. Search for EdgeWorkers in available behaviors.
Search for EdgeWorkers behavior
  1. Change the setting to On.
  2. Click Insert Behavior.
  3. Select the EdgeWorker ID that you created in step 1 from the list.
  4. Save your property.
  5. Click the Activate tab.
  6. Click the Activate on Staging button.

3. Create the code bundle

To create a code bundle you need a main.js source file and a bundle.json manifest file.

  1. Create a folder on your computer for the code bundle files.

  2. Go to the EdgeWorkers GitHub repository and download the main.js and bundle.json files from the redirect- geo project or create them using the values below.

This JavaScript sample is commented to help you understand the logic behind the use case and code.

/*
(c) Copyright 2023 Akamai Technologies, Inc. Licensed under Apache 2 license.
Version: 0.1
Purpose:  Using EdgeScape geo data, redirect user to country specific content
Repo: https://github.com/akamai/edgeworkers-examples/tree/master/redirect-geo
*/

//Define the top level domain mapping for Canada, the U.S., and UK.
const tldMap = {
  CA: '.ca',
  GB: '.co.uk',
  US: '.com'
};

//Implement onClient request as the first event before caching occurs.
export function onClientRequest (request) {
 
//Create a subdomain from the host of the incoming request. 
  const subDomain = request.host.split('.')[0];

//Create a domain from the host of the incoming request.  
  const domain = request.host.split('.')[1];

//Determine the top level domain based on the request's country of origin.
  let tld = tldMap[request.userLocation.country];

//Set the default domain to .com.
  if (tld === undefined) {
    tld = '.com';
  }

  //Build up new domain based on the location of the request. For example, .ca for Canada.
  const redirectDomain = subDomain + '.' + domain + tld;

 
//Check the incoming domain to see if the incoming domain is different from the built up domain.
  if (request.host !== redirectDomain) {

//Redirect to new host. If a redirect is required, return the location header with the new domain in the response.
    request.respondWith(302, {
      Location: [request.scheme + '://' + redirectDomain + request.url]
    }, '');
  }
}
  1. Create the bundle.json manifest file.
{
    "edgeworker-version": "1 ",
    "description" : "Perform redirect"
}
  1. Compress the files into a code bundle.
tar -czvf filename.tgz main.js bundle.json

4. Deploy the code bundle

To deploy the code bundle you need to create an EdgeWorker version.

  1. Go to ‚ėį > CDN > EdgeWorkers.

  2. From the EdgeWorkers IDs page, select the EdgeWorker ID that you just created.

  3. Click the Create version button.

  1. Drag and drop the code bundle onto the window and click the Create version button.

5. Activate the EdgeWorker version

  1. From the EdgeWorkers versions page, select your EdgeWorker ID.

    Only the EdgeWorkers you have permission to access appear in the list.

  2. Click the Activate version button.

  3. Select the EdgeWorker version that you want to activate.

  4. Select the Staging network to test your code sample.

6. Test the EdgeWorkers function

You can use a curl request, resolved to staging, to exercise the EdgeWorkers function.

ūüďė

For more information on how to resolve an IP address refer to the Getting Started for HTTPS Properties documentation.

  1. Use this curl request to test the locationBasedRedirect EdgeWorkers function.

    Replace [akamai staging name] with the staging Edge hostname of your website. The staging Edge hostname uses the .edgekey-staging.net domain.

curl https://[your website name]/redirectGeo --connect-to ::[akamai staging name] -H "Pragma: akamai-x-ew-debug" -sD -  -sD -
  1. The curl request should produce output similar the following.
HTTP/2 302 
location: https://[your website name]/redirectGeo
content-type: text/html
content-length: 0
expires: Wed, 07 Jun 2023 15:18:43 GMT
cache-control: max-age=0, no-cache, no-store
pragma: no-cache
date: Wed, 07 Jun 2023 15:18:43 GMT
server-timing: cdn-cache; desc=HIT
server-timing: edge; dur=1
x-akamai-edgeworker-onclientresponse-info: ew=9xx v:Demo_RedirectGeo; status=UnimplementedEventHandler
x-akamai-edgeworker-onclientrequest-info: ew=9xx v0.9.2:Demo_RedirectGeo; status=Success
server-timing: ak_p; desc="1686151123657_381190694_44213894_27_8634_24_54_15";dur=1