Skip to content

Custom Domains GA docs [DOC-980] #6834

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

Merged
merged 18 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
making required updates [netlify-build]
  • Loading branch information
forstisabella committed Jul 23, 2024
commit b5769758ae2a7f88859212edf11cc1de64733cfc
4 changes: 2 additions & 2 deletions src/_data/sidenav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,9 @@ sections:
- path: /connections/sources/debugger
title: Source Debugger
- path: /connections/sources/custom-domain
title: Custom Domains
title: Segment-Managed Custom Domain
- path: /connections/sources/catalog/libraries/website/javascript/custom-proxy
title: Custom Proxy
title: Self-Managed Custom Proxy
- path: /connections/sources/visual-tagger
title: Visual Tagger
- section_title: Schema
Expand Down
2 changes: 1 addition & 1 deletion src/_data/sidenav/strat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ sections:
- path: /connections/sources/catalog/libraries/website/javascript/quickstart
title: Quickstart tutorial
- path: /connections/sources/catalog/libraries/website/javascript/custom-proxy
title: Custom proxy for Analytics.js
title: Self-Managed Custom Proxy
- path: /connections/sources/catalog/libraries/website/javascript/persistence
title: Client-side persistence in Analytics.js
- path: /connections/sources/catalog/libraries/website/javascript/single-page-apps
Expand Down
8 changes: 8 additions & 0 deletions src/_includes/content/domain-delegation-solutions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Segment's domain delegation solutions

Segment offers two domain delegation solutions: [Custom Proxy](/docs/connections/sources/catalog/libraries/website/javascript/custom-proxy) and [Custom Domain](/docs/connections/sources/custom-domain).

| Service | How it works | Infrastructure management | Availability |
| ------- | ------------ | ------------------------- | ------------ |
| Custom Domain | A Segment service that allows your website to use your own subdomain to load Analytics.js securely over HTTPS and send event data. It is not limited to Analytics.js and is also compatible with server libraries. It uses a DNS subdomain that you delegate to Segment. | **Segment manages all related infrastructure**, including applying security updates, managing the SSL certificate lifecycle, and monitoring. | Available to users on a Business Tier plan. |
| Custom Proxy | This approach uses a Cannonical Name (CNAME) to map an alias name to the actual or 'cannonical' domain name. The CNAME record allows you to alias one domain name to another. | You must create a CNAME record to alias a subdomain that points to the Segment domain. <br><br> Customers are responsible for maintaining their own proxy infrastructure. | Available to all Segment users. |
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
---
title: Self Hosting or Proxying Analytics.js
title: Self-Managed Custom Proxy
redirect_from: '/connections/sources/custom-domains/'
strat: ajs
---

Custom domains allow you to proxy Analytics.js and proxy all tracking event requests through your domain.
Custom proxies allow you to proxy Analytics.js and proxy all tracking event requests through your domain.

You cannot use custom proxy setup for Analytics.js CDN or Tracking API with device-mode destinations because it requires the destination's native scripts are loaded onto the client, and the requests are sent directly to the destination.
You cannot use custom proxy setup for Analytics.js CDN or Tracking API with device-mode destinations because it requires the destination's native scripts are loaded onto the client, and the requests are sent directly to the destination.

> info "Business Tier customers can also use Custom Domain"
> Custom Domain is a fully-managed service that enables you to configure a first-party subdomain over HTTPS to track event requests through your domain instead of tracking events through Segment's default domain. For more information, see the [Custom Domain](/docs/connections/sources/custom-domain) documentation.

{% include content/domain-delegation-solutions.md %}

## Custom Proxy prerequisites

To set up a custom domain, you need:
To set up a custom proxy, you need:

- Access to your site DNS settings
- A CDN you can serve assets from
Expand All @@ -20,7 +25,7 @@ To set up a custom domain, you need:
> info "Custom Proxy Troubleshooting"
> If you experience issues configuring a custom proxy, contact your organization's IT department for help. Segment does not have access to the resources you need to configure a custom proxy.

This guide explains how to set up a custom domain in CloudFront. You can apply these principles to almost any modern CDN that supports proxies.
This guide explains how to set up a custom proxy in CloudFront. You can apply these principles to almost any modern CDN that supports proxies.

You need to set up two important parts, regardless of the CDN provider you use:

Expand Down
8 changes: 2 additions & 6 deletions src/connections/sources/custom-domain.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Custom Domain
title: Segment-Managed Custom Domain
plan: custom-domain
hidden: true
---
Expand All @@ -11,11 +11,7 @@ Custom Domain is a fully-managed service that enables you to configure a first-p
> success ""
> Segment recommends configuring Custom Domain alongside [Consent Management](/docs/privacy/consent-management/) to ensure you are respectful of your end users' consent preferences.

## Compare Segment's domain delegation solutions

Segment has two domain delegation solutions:
- **Custom Domain**: Uses a DNS subdomain that you delegate to Segment
- **[Custom Proxy](/docs/connections/sources/catalog/libraries/website/javascript/custom-proxy/)**: Uses a Canonical Name (CNAME) to map an alias name to a true or 'canonical' domain name. The CNAME record allows you to alias one domain name to another. You create a CNAME record to alias a subdomain that points to the Segment domain.
{% include content/domain-delegation-solutions.md %}

### How DNS subdomain delegation works
DNS subdomain delegation is a process where the control of a specific subdomain is assigned to another DNS server, allowing that server to manage the DNS records for the subdomain. This delegation is useful for distributing the management of DNS records and enables specialized handling of subdomain traffic.
Expand Down