Skip to content

Commit 2431a48

Browse files
committed
docs: polish example
1 parent 34225c3 commit 2431a48

File tree

3 files changed

+27
-24
lines changed

3 files changed

+27
-24
lines changed

examples/minimal/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
## Minimal example for Fingerprint Fastly VCL Proxy Integration
22

3-
This project is an example of how to create a Fastly VCL service for the [Fingerprint Fastly VCL proxy integration Terraform module](https://github.com/fingerprintjs/terraform-fastly-fingerprint-vcl-proxy-integration).
3+
This is an example Terraform project using [Fingerprint Fastly VCL proxy integration Terraform module](https://github.com/fingerprintjs/terraform-fastly-fingerprint-vcl-proxy-integration).
44
Learn more in the [Fastly VCL Proxy Terraform installation guide](https://dev.fingerprint.com/docs/deploy-fastly-vcl-using-terraform).
55

66
### Running the example
77

88
To quickly run the example for testing purposes, you can:
99

10-
1. Copy the [terraform.tfvars.example](./terraform.tfvars.example) file into a new `terraform.tfvars` file and replace the values with your own. The variables are defined and described in the [variables.tf](./variables.tf) file
10+
1. Copy the [terraform.tfvars.example](./terraform.tfvars.example) file into a new `terraform.tfvars` file and replace the values with your own.
1111
```shell
1212
cd examples/minimal && cp terraform.tfvars.example terraform.tfvars
1313
```
14-
2. Copy your Fastly API token
15-
3. Run `terraform init`
16-
4. Run `terraform apply -target=module.fingerprint_fastly_vcl_integration.module.vcl_asset`
17-
5. Run `terraform plan`
18-
6. Run `terraform apply`
14+
The variables are defined and described in the [variables.tf](./variables.tf).
15+
2. Run `terraform init`
16+
3. Run `terraform apply -target=module.fingerprint_fastly_vcl_integration.module.vcl_asset`
17+
4. Run `terraform plan`
18+
5. Run `terraform apply`
1919

2020
### Using in production
2121

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
agent_script_download_path = "463N7"
2-
get_result_path = "r35U17"
3-
integration_path = "zyk12Xc"
1+
# Replace the values with your own, random paths recommended
2+
agent_script_download_path = "agent"
3+
get_result_path = "result"
4+
integration_path = "fp"
45
proxy_secret = "YOUR_PROXY_SECRET_KEY_CREATED_IN_FINGERPRINT_DASHBOARD"
56
fastly_api_token = "YOUR_API_TOKEN_CREATED_IN_FASTLY_DASHBOARD"
6-
integration_domain = "metrics.yourwebsite.com" # <- Your test domain will be this: `https://metrics.yourwebsite.com.global.prod.fastly.net`
7+
// You can test the integration using the Fastly test domain, like `https://metrics.yourwebsite.com.global.prod.fastly.net`
8+
integration_domain = "metrics.yourwebsite.com"
79
main_host = "yourwebsite.com"

examples/minimal/variables.tf

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,34 @@
1-
variable "agent_script_download_path" {
2-
description = "The Fingerprint agent download will be proxied through this path"
1+
variable "proxy_secret" {
2+
description = "Your Fingerprint proxy secret"
33
type = string
44
}
55

6-
variable "get_result_path" {
7-
description = "The Fingerprint agent download will be proxied through this path"
6+
variable "fastly_api_token" {
7+
description = "Your Fastly API token"
88
type = string
99
}
1010

1111
variable "integration_path" {
12-
description = "The Fingerprint integration will be proxied through this path prefix"
12+
description = "Path prefix for the proxied requests"
1313
type = string
1414
}
1515

16-
variable "integration_domain" {
17-
description = "Domain used for your proxy integration"
16+
variable "agent_script_download_path" {
17+
description = "Path for downloading the Fingerprint JavaScript Agent"
1818
type = string
1919
}
2020

21-
variable "main_host" {
22-
description = "Your origin server domain"
21+
variable "get_result_path" {
22+
description = "Path for proxying identification requests"
2323
type = string
2424
}
2525

26-
variable "proxy_secret" {
27-
description = "Your Fingerprint proxy secret"
26+
variable "integration_domain" {
27+
description = "Domain used for your proxy integration"
2828
type = string
2929
}
3030

31-
variable "fastly_api_token" {
31+
variable "main_host" {
32+
description = "Your origin server domain"
3233
type = string
33-
}
34+
}

0 commit comments

Comments
 (0)