Skip to content

Commit c87c146

Browse files
markzegarellistayseesong
andauthored
Apply suggestions from code review
Co-authored-by: stayseesong <[email protected]>
1 parent 175822d commit c87c146

File tree

1 file changed

+20
-8
lines changed
  • src/connections/sources/catalog/libraries/website/javascript

1 file changed

+20
-8
lines changed

src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ A Segment Customer Success team member will respond that they have enabled this
4747
These instructions refer to Amazon CloudFront, but apply more generally to other providers as well.
4848

4949
### CDN Proxy
50-
51-
1. First log in to the AWS console and navigate to CloudFront.
50+
To set up your CDN Proxy:
51+
1. Log in to the AWS console and navigate to CloudFront.
5252
2. Click **Create Distribution**.
5353
3. Configure the distribution settings. In the Origin section, update the following values:
5454
- **Origin Domain Name**: `cdn.segment.com`
@@ -58,14 +58,21 @@ These instructions refer to Amazon CloudFront, but apply more generally to other
5858
- **Allowed HTTP Methods**: `GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE`
5959
5. In the Settings section, configure the following values:
6060
- **Alternate domain name (CNAME)**: `analytics.<yourdomain>.com`
61-
- **Custom SSL certificate**: Select an existing or select a new certificate to validate the authorization to use the **Alternate domain name (CNAME)** value. For more information, see Amazon's documentation [Requirements for using alternate domain names](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-requirements){:target="_blank"}
61+
- **Custom SSL certificate**: Select an existing or new certificate to validate the authorization to use the **Alternate domain name (CNAME)** value. For more information, see Amazon's documentation [Requirements for using alternate domain names](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-requirements){:target="_blank"}.
6262
6. Click **Create Distribution**.
6363

64-
Take note of the Domain Name, for use in the next step.
64+
Take note of the Domain Name for use in the next step.
6565

6666
#### Add CNAME Record to DNS
6767

68-
Next, add a CNAME record for the Segment proxy to your organizations DNS settings. Use a name that makes it clear what you are using the subdomain for, for example `analytics.mysite.com`. Go to your domain registrar and add a new record to your DNS of type "CNAME".
68+
To add a CNAME record for the Segment proxy to your organizations DNS settings:
69+
1. Use a name that makes it clear what you are using the subdomain for, for example `analytics.mysite.com`.
70+
2. Go to your domain registrar and add a new record to your DNS of type "CNAME".
71+
3. Configure these values:
72+
- **Name**: `<subdomain_name>.yourdomain.com`
73+
- **Value**: The Domain Name value from CloudFront
74+
4. Save your record. This might take some time to take effect, depending on your TTL settings.
75+
5. Make a `curl` request to your domain to verify that the proxy works.
6976

7077

7178
| Field | Value |
@@ -77,7 +84,7 @@ Save your record. This might take some time to take effect, depending on your TT
7784

7885
### Tracking API Proxy
7986

80-
Next, set up a proxy for the tracking API so that all calls proxy through your domain. In this step, set up a CloudFront distribution that's similar to the previous step, with the exception of the Origin Domain Name:
87+
Set up a proxy for the tracking API so that all calls proxy through your domain. To do this, set up a CloudFront distribution that's similar to the one in the previous section, with the exception of the Origin Domain Name:
8188

8289
| Field | Value | Description |
8390
| ------------------ | ---------------- | -------------------------------------------- |
@@ -86,12 +93,17 @@ Next, set up a proxy for the tracking API so that all calls proxy through your d
8693

8794
#### Add CNAME Record to DNS
8895

89-
Next, add a CNAME record to your DNS settings. Go to your domain registrar and add a new record to your DNS of type "CNAME". This time use the CloudFront distribution for the tracking API proxy.
96+
To add a CNAME record to your DNS settings:
97+
1. Go to your domain registrar and add a new record to your DNS of type "CNAME". This time use the CloudFront distribution for the tracking API proxy.
98+
2. Enter values for these fields:
99+
- **Name**: `<subdomain_name>.yourdomain.com`
100+
- **Value**: Tracking API CloudFront Distribution Domain Name
101+
3. Save your record. This might take some time to take effect, depending on your TTL settings.
102+
4. Run `curl` on your domain to check if the proxy is working correctly.
90103

91104
| Field | Value |
92105
| ----- | -------------------------------------------------- |
93106
| Name | `<subdomain_name>.yourdomain.com` |
94107
| Value | *Tracking API CloudFront Distribution Domain Name* |
95108

96109

97-
Save your record. This might take some time to take effect, depending on your TTL settings. Try running `curl` on your domain to check if the proxy is working correctly.

0 commit comments

Comments
 (0)