Installation with npm

Prerequisites

• DATADOME_SERVER_SIDE_KEY available in your DataDome dashboard,
• DATADOME_CLIENT_SIDE_KEY available in your DataDome dashboard,
• a Worker project. If you don't have one, you can create one easily following Cloudflare documentation.

Protect your traffic

1. Inside your existing Worker project directory, run the command:

   npmyarn

   npm install @datadome/module-cloudflare-worker

   yarn add @datadome/module-cloudflare-worker

2. Replace your existing src/index.ts (or main worker file) with:

   TypeScriptJavascript

   import { activateDataDome } from '@datadome/module-cloudflare-worker';
   
   // Your custom handler
   const myHandler: ExportedHandler<Env> = {
       async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
           // Your custom logic here
           return new Response('Hello from my worker!', {
               headers: { 'content-type': 'text/plain' },
           });
       },
   };
   
   // The handler that wires up DataDome with env-based config
   const handler: ExportedHandler<Env> = {
       async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
           // Pass env values to DataDome at runtime
           const dataDomeHandler = activateDataDome(myHandler, {
               serverSideKey: env.DATADOME_SERVER_SIDE_KEY,
               clientSideKey: env.DATADOME_CLIENT_SIDE_KEY,
               // ...other options
           });
   
           if (dataDomeHandler.fetch) {
             try {
               return dataDomeHandler.fetch(request as any, env, ctx);
             } catch (_) {
               return myHandler.fetch(request, env, ctx)
             }
           }
   
           return myHandler.fetch(request, env, ctx)
       },
   };
   
   // Export as the worker's default export
   export default handler;

   import { activateDataDome } from '@datadome/module-cloudflare-worker';
   
   // Your custom handler
   const myHandler = {
       async fetch(request, env, ctx) {
           // Your custom logic here
           return new Response('Hello from my worker!', {
               headers: { 'content-type': 'text/plain' },
           });
       },
   };
   
   // The handler that wires up DataDome with env-based config
   const handler = {
       async fetch(request, env, ctx) {
           // Pass env values to DataDome at runtime
           const dataDomeHandler = activateDataDome(myHandler, {
               serverSideKey: env.DATADOME_SERVER_SIDE_KEY,
               clientSideKey: env.DATADOME_CLIENT_SIDE_KEY,
               // ...other options
           });
   
           if (dataDomeHandler.fetch) {
               try {
                   return dataDomeHandler.fetch(request, env, ctx);
               } catch (_) {
                   return myHandler.fetch(request, env, ctx);
               }
           }
   
           return myHandler.fetch(request, env, ctx);
       },
   };
   
   // Export as the worker's default export
   export default handler;

3. Create a Cloudflare Worker secret named DATADOME_SERVER_SIDE_KEY:

wrangler secret put DATADOME_SERVER_SIDE_KEY

A prompt appears. Enter the value of your DataDome server-side key you can find in your DataDome Dashboard.

4. Create a Cloudflare Worker secret named DATADOME_CLIENT_SIDE_KEY:

wrangler secret put DATADOME_CLIENT_SIDE_KEY

A prompt appears. Enter the value of your DataDome client-side key you can find in your DataDome Dashboard.

5. Deploy your updated Worker:
   deploy

   wrangler deploy

Congrats! You can now see your traffic in your DataDome dashboard.

Configuration

The configuration is done inside the code, using constants.

Server-side settings

 /\.(avi|flv|mka|mkv|mov|mp4|mpeg|mpg|mp3|flac|ogg|ogm|opus|wav|webm|webp|bmp|gif|ico|jpeg|jpg|png|svg|svgz|swf|eot|otf|ttf|woff|woff2|css|less|js|map)$/i

Client-side settings

Update

1. Run

npm update @datadome/module-cloudflare-worker

2. Deploy with Wrangler:

wrangler deploy

Uninstallation

1. Remove this line from your worker file:
   TypeScript

   import { activateDataDome } from '@datadome/module-cloudflare-worker'

2. Replace this:
   TypeScript

   const handler = activateDataDome(myHandler, options);

   With your original handler:
   TypeScript

   const handler = myHandler;

3. Delete these from your wrangler.toml:
   TOML

   [vars]
   DATADOME_SERVER_SIDE_KEY = "..."
   DATADOME_CLIENT_SIDE_KEY = "..."

4. Uninstall the package
   Bash

   npm uninstall @datadome/module-cloudflare-worker

   
   

Logging

DataDome custom logging

1. Inside your wrangler.toml file add:

   [observability.logs]
   enabled = true

2. Deploy with

   wrangler deploy

3. By default, DataDome logs errors only (such as errors in the configuration). If you want to have detailed logs for debugging, you can modify the DataDome Worker script and set DATADOME_ENABLE_DEBUGGINGto true.

DataDome logs format

The DataDome custom logs have the following format:

{
  "step": "string",
  "result": "string", 
  "reason": "string",
  "details": {
    "key": "value"
  },
  "company": "DataDome",
  "line": 123
}

Logpush

You can use Logpush to send logs to a destination supported by Logpush (Datadog, Splunk, S3 Bucket…).

❗️

Cloudflare plan

Logpush is available to customers on Cloudflare’s Enterprise plan.

Update the Worker’s script

1. Fill the DATADOME_LOGPUSH_CONFIGURATION value with the name of the values you want, as an Array of Strings.
   The possible values are available in the Enriched headers page.

Eg:

DATADOME_LOGPUSH_CONFIGURATION = "["X-DataDome-botname", "X-DataDome-isbot", "x-datadomeresponse"]"

Enable Logpush

2. Inside your wrangler.toml file add:

logpush = true

3. Deploy with wrangler.

Add custom fields

Requires version 2.2.0 of the CloudflareWorker module.

📘

Custom fields feature

DataDome let you enrich in real time our detection engine by sending us some custom fields with your business data. These fields can be used for specific detection models.

👋 Please reach out to our support team for reviewing the data received.

Sample a callback function to set custom fields dynamically
The callback is a function receiving a single parameter, the Cloudflare Http request - defined here:

// Sample code for custom fields  
// when calling activateDataDome
 const dataDomeHandler = activateDataDome(myHandler, {
   serverSideKey: env.DATADOME_SERVER_SIDE_KEY,
   clientSideKey: env.DATADOME_CLIENT_SIDE_KEY,
   customFieldString1: function (request) {
     if (request.headers['x-user-tier'] && request.headers['x-user-tier'][0] 
				&& request.headers['x-user-tier'][0].value) {  
       return request.headers['x-user-tier'][0].value;  
     } else {  
       return 'standard';  
     }
   }, 
   // ...other options
 });