Skip to content

Release v1.0.0-rc.1 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## [1.0.0-rc.2](https://github.com/fingerprintjs/terraform-fastly-compute-fingerprint-proxy-integration/compare/v1.0.0-rc.1...v1.0.0-rc.2) (2025-08-05)


### Features

* add variable manage_fastly_config_store_entries ([760f4cd](https://github.com/fingerprintjs/terraform-fastly-compute-fingerprint-proxy-integration/commit/760f4cd2c3ea6f41eaceb934eface98ac0bbefb6))

## 1.0.0-rc.1 (2025-07-23)


### Features

* add example ([d55e148](https://github.com/fingerprintjs/terraform-fastly-compute-fingerprint-proxy-integration/commit/d55e148f531599d5b3a66f9e90ac8d584c62d2cd))
* remove fastly secret store item ([d4a2283](https://github.com/fingerprintjs/terraform-fastly-compute-fingerprint-proxy-integration/commit/d4a228396503bc8f07c3e4aa3780de26baca9fd8))


### Bug Fixes

* trigger initial release ([d7b97b2](https://github.com/fingerprintjs/terraform-fastly-compute-fingerprint-proxy-integration/commit/d7b97b2f5481cb221d5a2d47882861e648635a1f))
* update backends for compute compatability ([44b7966](https://github.com/fingerprintjs/terraform-fastly-compute-fingerprint-proxy-integration/commit/44b7966d42b6b5bb12d268f27181628b897f4622))
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,25 @@ module "fingerprint_fastly_compute_integration" {
fpjs_cdn_url = "procdn.fpjs.sh" # <- Update CDN origin here
}
```

## Using Release Candidates

To use a release candidate version of the module, specify it explicitly in the version field:

```terraform
module "fingerprint_fastly_compute_integration" {
source = "fingerprintjs/compute-fingerprint-proxy-integration/fastly"
version = "1.0.0-rc.1"
# Other module inputs
}
```

Alternatively, you can point directly to the GitHub repository and use a branch (e.g., `rc`) via the ref parameter.
This ensures you're always using the latest commit from that branch:

```terraform
module "fingerprint_fastly_compute_integration" {
source = "github.com/fingerprintjs/terraform-fastly-compute-fingerprint-proxy-integration?ref=rc"
# Other module inputs
}
```
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ terraform {
}

module "fingerprint_fastly_compute_integration" {
source = "github.com/fingerprintjs/temp-fastly-compute-terraform"
source = "fingerprintjs/compute-fingerprint-proxy-integration/fastly"
fastly_api_token = "FASTLY_API_TOKEN"
service_id = "EMPTY_FASTLY_COMPUTE_SERVICE_ID"
agent_script_download_path = "AGENT_SCRIPT_DOWNLOAD_PATH"
Expand All @@ -67,23 +67,24 @@ module "fingerprint_fastly_compute_integration" {

You can see the full list of the Terraform module's variables below:

| Variable | Description | Required | Example |
|--------------------------------|---------------------------------------------------------|----------|---------------------------------------------------------|
| `fastly_api_token` | Your Fastly API token | Required | `"ABC123...xyz"` |
| `service_id` | ID of your empty Fastly Compute service | Required | `"SU1Z0isxPaozGVKXdv0eY"` |
| `agent_script_download_path` | Path to serve agent script from your domain | Required | `"4fs80xgx"` |
| `get_result_path` | Path to serve identification and browser cache requests | Required | `"vpyr9bev"` |
| `integration_domain` | Domain used for your proxy integration | Required | `"metrics.yourdomain.com"` |
| `integration_name` | Name of Fastly service | Optional | `"fingerprint-fastly-compute-proxy-integration"` |
| `download_asset` | Whether to auto-download latest release | Optional | `true` |
| `compute_asset_name` | Custom filename if not downloading | Optional | `"fingerprint-fastly-compute-proxy-integration.tar.gz"` |
| `asset_version` | GitHub release version of proxy integration | Optional | `"latest"` |
| `kv_store_enabled` | Enable KV store integration | Optional | `false` |
| `kv_store_save_plugin_enabled` | Enables plugin to save to KV store | Optional | `"false"` |
| `fpjs_backend_url` | Domain for Ingress endpoint & browser cache endpoint | Optional | `"api.fpjs.io"` |
| `fpjs_cdn_url` | Domain for Agent Script | Optional | `"fpcdn.io"` |

### 2. Deploy your Terraform changes
| Variable | Description | Required | Example |
|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------|
| `fastly_api_token` | Your Fastly API token | Required | `"ABC123...xyz"` |
| `service_id` | ID of your empty Fastly Compute service | Required | `"SU1Z0isxPaozGVKXdv0eY"` |
| `agent_script_download_path` | Path to serve agent script from your domain | Required | `"4fs80xgx"` |
| `get_result_path` | Path to serve identification and browser cache requests | Required | `"vpyr9bev"` |
| `integration_domain` | Domain used for your proxy integration | Required | `"metrics.yourdomain.com"` |
| `integration_name` | Name of Fastly service | Optional | `"fingerprint-fastly-compute-proxy-integration"` |
| `download_asset` | Whether to auto-download latest release | Optional | `true` |
| `compute_asset_name` | Custom filename if not downloading | Optional | `"fingerprint-fastly-compute-proxy-integration.tar.gz"` |
| `asset_version` | GitHub release version of proxy integration | Optional | `"latest"` |
| `kv_store_enabled` | Enable KV store integration | Optional | `false` |
| `kv_store_save_plugin_enabled` | Enables plugin to save to KV store | Optional | `"false"` |
| `fpjs_backend_url` | Domain for Ingress endpoint & browser cache endpoint | Optional | `"api.fpjs.io"` |
| `fpjs_cdn_url` | Domain for Agent Script | Optional | `"fpcdn.io"` |
| `manage_fastly_config_store_entries` | Manage Fastly Config Store entries via terraform, see [Fastly documentation](https://registry.terraform.io/providers/fastly/fastly/latest/docs/resources/configstore_entries#manage_entries-1) | Optional | `false` |

### 3. Deploy your Terraform changes

1. Initialize the Terraform module

Expand All @@ -110,7 +111,7 @@ You can see the full list of the Terraform module's variables below:
```shell
terraform apply
```
### 3. Add the proxy secret to your Fastly Secret Store
### 4. Add the proxy secret to your Fastly Secret Store

1. Using the [Fastly web interface](https://manage.fastly.com/compute), open the Secret Store created for your service by Terraform. It will be named `Fingerprint_Compute_Secret_Store_<SERVICE_ID>`.
2. Add a `PROXY_SECRET` item with your Fingerprint proxy secret as the value.
Expand Down
1 change: 1 addition & 0 deletions main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ resource "fastly_configstore" "integration_config_store" {

resource "fastly_configstore_entries" "integration_config_store_entries" {
store_id = fastly_configstore.integration_config_store.id
manage_entries = var.manage_fastly_config_store_entries
entries = {
AGENT_SCRIPT_DOWNLOAD_PATH = var.agent_script_download_path
GET_RESULT_PATH = var.get_result_path
Expand Down
7 changes: 7 additions & 0 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ variable "config_store_prefix" {
}
}

variable "manage_fastly_config_store_entries" {
type = bool
default = false
nullable = false
description = "Manage Fastly Config Store entries via terraform, see link: https://registry.terraform.io/providers/fastly/fastly/latest/docs/resources/configstore_entries#manage_entries-1"
}

variable "secret_store_prefix" {
type = string
default = "Fingerprint_Compute_Secret_Store_"
Expand Down
Loading