jasima/sitelen-tu
3
1
Fork 0
Code Issues 2 Pull requests Projects Releases Packages 1 Wiki Activity Actions

doc: adds details on configuring first-party tealium & adobe

Browse source
This commit is contained in:
Iain Learmonth 2025-05-03 16:06:36 +01:00
parent 908123fa40
commit 55faad4b83
1 changed files with 41 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -59,7 +59,9 @@ Each origin is required to have a JSON configuration object available in the Red
The following keys are meaningful in this object:
| Key | Description | Default | Example |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|-----------------------------|
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| `first_party_adobe` | See section below. | Feature disabled. | `{"subdomain": "ssc", "account": "example"}` |
| `first_party_tealium` | See section below. | Feature disabled. | `{"subdomain": "tags", "account": "example"}` |
| `geo_redirect_disable` | Disables redirecting to the canonical host when a mirror likely isn't needed based on the viewer's geography. | Requests are redirected based on a hardcoded list of countries unlikely to have implemented censorship. | `true` |
| `headers` | Append additional headers to the request sent to the origin. | No additional headers are added. | `{"X-Example": "Hello"}` |
| `host_connect` | Override the hostname that is used to connect to the origin. This can be useful in the case that the origin is begind a CDN that you want to avoid having to traverse, either due to DDoS protection tools being falsely triggered or simply to save costs. | The canonical host is used. | `"real-origin.example.com"` |
@ -71,6 +73,35 @@ The following keys are meaningful in this object:
Note: the default case applies when the key is omitted.
### 🍪 First-Party Tealium & Adobe Analytics
**Watch Out!** This feature was implemented specifically for the US Agency for Global Media and may not work correctly
for others. If it works for you, then great. If it doesn't, we could potentially accept a pull request that either
adapts the existing feature, or just adds a new one for you. If you're so inclined then we'd be really happy to accept
a feature that allowed for custom Lua code to be added on a per-deployment basis.
The configuration for both services are the same. The assumption is that the first-party subdomain chosen is always a
subdomain of the registered domain name (i.e. an extension on the Mozilla Public Suffix List + one name). For example:
| Site | Registered Domain | First-Party App Subdomain |
|-----------------|-------------------|---------------------------|
| www.example.com | example.com | tags.example.com |
| ir.example.com | example.com | tags.example.com |
| example.com | example.com | tags.example.com |
In this example, the `subdomain` property to configure for this app would be `"tags"`.
The account name is the account name registered with the application. You can usually find this from the URL provided
to you for inclusion in your HTML.
**Tealium:** The Universal Tag code contains a URL that looks like:
`//tags.tiqcdn.com/utag/ACCOUNT/PROFILE/ENVIRONMENT/utag.js`.
The `ACCOUNT` here should be used for the `account` property in the configuration.
**Adobe Analytics:** Look for a URL like:
`https://ACCOUNT.sc.omtrdc.net/b/ss/`.
Again, `ACCOUNT` is what should be used for the `account` property in the configuration.
## 🖋️ Copyright
Copyright © 2025 SR2 Communications Limited.