> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fingerprint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deploy Akamai Integration using Terraform

<Info>
  **Before you start: Read the general Akamai guide**

  This document only covers deploying the Fingerprint Akamai proxy integration using Terraform. It assumes you have already read the [general Akamai guide][akamai-guide] and completed the following steps:

  * [Step 1][akamai-step-1]: You have issued a proxy secret in the Fingerprint Dashboard (`FPJS_PROXY_SECRET`).
  * [Step 2][akamai-step-2]: You have defined a path variable for the integration (`FPJS_INTEGRATION_PATH`)

  If you want to use Akamai Property Manager API instead of Terraform to install the integration, see [Install Akamai proxy integration using Akamai Property Manager API][akamai-papi].
</Info>

<Warning>
  **Limitations**

  This integration is exclusively supported for customers on the **Enterprise** Plan. Other customers are encouraged to use [Custom subdomain setup][custom-subdomain] or [Cloudflare Proxy Integration][cloudflare-proxy].
</Warning>

<Warning>
  **Requirements: Terraform setup and `latest` rule format expected**

  This guide assumes you use Terraform to manage your site infrastructure on Akamai and that your site uses the `latest` Akamai rule format. If your Akamai property uses a different rule format or a different deployment method, please contact our [support team][support].
</Warning>

To install the integration, adjust your Terraform configuration to incorporate the variable blocks, property rules, and property variables required by the integration.

## Step 3: Add `variable` blocks to your rules template

<Warning>
  The following section assumes you are using the [Rules template][akamai-rules-template] to manage your Akamai property rules. If you are using a plain JSON file instead, reach out to our [support team][support].
</Warning>

Specify a randomized path value and the Fingerprint proxy secret you have created in [Step 1][akamai-step-1]:

* `fpjs_integration_path`
* `fpjs_proxy_secret`

For the path value, pick any random string that is a valid URL path. Be careful not to include words often blocked by ad blockers, such as *fingerprint* or *fpjs*. You can use [any random value generator][random-value-generator] or Terraform's [Random Provider][terraform-random-provider] if you prefer.

Find the `akamai_property_rules_template` data block in your Terraform configuration file and add the three variables:

```terraform main.tf theme={"theme":"github-dark-dimmed"}
data "akamai_property_rules_template" "rules" {
      # Assuming this is property's rules file
      template_file = "/rules/main.json"
      variables {
        name  = "fpjs_integration_path"
        value = "FPJS_INTEGRATION_PATH"
        type = "string"
      }
      variables {
        name  = "fpjs_integration_path_escaped"
        value = "YOUR_INTEGRATION_PATH_ESCAPED" # same as FPJS_INTEGRATION_PATH but with / escaped as \\/ and . escaped as \.
        type = "string"
      }
      variables {
        name  = "fpjs_proxy_secret"
        value = "FPJS_PROXY_SECRET"
        type = "string"
      }
}
```

<Note>
  **Note: Proxy secret required**

  Proxied identification requests without a valid proxy secret will result in an authentication error and not receive identification results.
</Note>

## Step 4: Add Fingerprint property rules

1. Go to the integration's [latest releases on GitHub][proxy-latest-release].
2. Download the `terraform-fingerprint-property-rules.json` file.
3. Add it to your Terraform project's `rules` directory as `fingerprint-property-rules.json`.
4. Reference the file in `rules/main.json` like below:

```javascript rules/main.json theme={"theme":"github-dark-dimmed"}
// rules/main.json
{
  "rules": {
    "name": "default",
    "behaviors": [
      // ...
    ],
    "children": [
      // ...other rule files
      // Add the downloaded rules file
      "#include:fingerprint-property-rules.json"
    ],
    // ...
  }
}
```

## Step 5: Add Fingerprint property variables

1. Go to the integration's [latest releases on GitHub][proxy-latest-release].
2. Download the `terraform-fingerprint-property-variables.json` file.
3. Add it to your Terraform project's `rules` directory as `fingerprint-property-variables.json`.
4. Reference the file in `rules/main.json`:

* If you don't have a `variables` field, add the `variables: "#include:fingerprint-property-variables.json"` line.
* If you already have a `variables` field, merge `fingerprint-property-variables.json` with your existing variables file.

```javascript rules/main.json theme={"theme":"github-dark-dimmed"}
// rules/main.json
{
  "rules": {
    "name": "default",
    "behaviors": [
      // ...
    ],
    "children": [
      //...
      "#include:fingerprint-property-rules.json"
    ],
    // Add the downloaded variables file (or merge it with existing variables file)
    "variables": "#include:fingerprint-property-variables.json"
    // ...
  }
}
```

<Note>
  **Property variables vs Terraform variable blocks**

  Note that the Akamai property variables added in Step 5 are different from the Terraform variable blocks added in Step 3.

  * Property variables are used by property rules and you cannot change them.
  * You can change the variable block values (randomized path and the proxy secret) according to your needs.
</Note>

## Step 6: Apply Terraform changes

1. Run `terraform plan` to review your changes.
2. Run `terraform apply`.

After your property deploys, you can access Fingerprint CDN and API through the chosen path on your website.

## Step 7: Configure the client agent

Please see the main Akamai proxy integration guide to [Configure the client agent on your website or mobile app][akamai-configure-agent].

[akamai-configure-agent]: /docs/akamai-proxy-integration#configure-fingerprint-agent

[akamai-guide]: /docs/akamai-proxy-integration

[akamai-papi]: /docs/deploy-akamai-proxy-integration-via-papi

[akamai-rules-template]: https://techdocs.akamai.com/terraform/docs/pm-ds-rules-template

[akamai-step-1]: /docs/akamai-proxy-integration#step-1-issue-a-fingerprint-proxy-secret

[akamai-step-2]: /docs/akamai-proxy-integration#step-2-create-a-path-variable

[cloudflare-proxy]: /docs/cloudflare-integration

[custom-subdomain]: /docs/custom-subdomain-setup

[proxy-latest-release]: https://github.com/fingerprintjs/akamai-proxy/releases/latest

[random-value-generator]: https://www.random.org/strings/?num=3&len=12&digits=on&loweralpha=on&unique=on&format=html&rnd=new

[support]: https://fingerprint.com/support/

[terraform-random-provider]: https://registry.terraform.io/providers/hashicorp/random/latest/docs