You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: content/docs/capabilities/custom-domains.mdx
+18-24
Original file line number
Diff line number
Diff line change
@@ -26,38 +26,21 @@ See the Clusters Concepts page for more information about clusters in Pomerium Z
26
26
27
27
## Custom Domains
28
28
29
-
In Pomerium Zero, a **Custom Domain** is a wildcard sub-domain you can use for Pomerium routes. After a one-time setup with your DNS provider, Pomerium will automatically provision and renew a TLS certificate for this sub-domain.
29
+
In Pomerium Zero, a **Custom Domain** is a wildcard subdomain you can use to build routes in Pomerium. After adding the appropriate record to your DNS provider, Pomerium will automatically provision and renew a TLS certificate for this subdomain.
30
30
31
-
After you successfully add a custom domain to your cluster, Pomerium will automatically issue and renew X.509 wildcard certificates on behalf of the domain to secure the connection over TLS.
32
-
33
-
### Fully Qualified Domain Names
34
-
35
-
In the context of Pomerium Zero, an FQDN is the complete domain name of a custom domain. The example below resembles a valid custom domain, where `mycorp` is the subdomain and `example.com` is the domain name:
36
-
37
-
`mycorp.example.com`
38
-
39
-
If you build routes with this custom domain to upstream services with hostnames like `verify`, `internal-tool`, and `authenticate`, your routes would look like:
31
+
For example, if you added a custom domain like `mycorp.example.com` to Pomerium Zero, you could build routes like:
40
32
41
33
-`verify.mycorp.example.com`
42
34
-`internal-tool.mycorp.example.com`
43
35
-`authenticate.mycorp.example.com`
44
36
45
-
### DNS validation
46
-
47
-
In order for Pomerium to issue certificates on behalf of a custom domain, you must prove that you control the domain name specified in the certificate through DNS validation. Per the [ACME protocol](https://datatracker.ietf.org/doc/html/rfc8555#section-2), Pomerium uses its own ACME client to communicate with Let's Encrypt, a free Certificate Authority, to validate a domain's DNS records.
48
-
49
-
Let's Encrypt provides several [challenge types](https://letsencrypt.org/docs/challenge-types/) to validate a domain, including the [DNS-01 challenge](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge). At a high level, this challenge requires that either:
50
-
51
-
- A `TXT` record must be placed at `_acme-challenge.<YOUR_DOMAIN>`
52
-
- Or, a `CNAME` record must be placed at `_acme-challenge.<YOUR_DOMAIN>` that points to another domain with the `TXT` record
53
-
54
-
Because Pomerium owns the `pomerium.app` subdomain, we can write the `TXT` record for you. All you need to do is point a **wildcard CNAME record** to your cluster's starter domain.
37
+
## How to add a custom domain
55
38
56
-
Refer to the steps in [**How to add a custom domain**](#how-to-add-a-custom-domain) for specific instructions.
39
+
Add a wildcard CNAME record that points to your starter domain. For example:
Add a wildcard CNAME record that points to your starter domain:
43
+
In Google Cloud Platform, you can manage DNS records using the Cloud DNS interface:
61
44
62
45

63
46
@@ -72,7 +55,7 @@ Add the custom domain in the Zero Console:
72
55
1. Select **Settings**
73
56
1. In the **Editing Clusters Settings** dashboard, select **Domains**
74
57
1. In the **Custom Domains** field, select the **+** icon to add a domain name
75
-
1. Enter your FQDN
58
+
1. Enter your custom domain
76
59
77
60

78
61
@@ -83,3 +66,14 @@ If added successfully, you will be able to build routes with your custom domain
83
66
You can also review the certificate in the **Certificates** dashboard:
84
67
85
68

69
+
70
+
### How custom domains work
71
+
72
+
In order for Pomerium to provision certificates on behalf of a custom domain, you must prove that you control the domain name specified in the certificate through DNS validation. Per the [ACME protocol](https://datatracker.ietf.org/doc/html/rfc8555#section-2), Pomerium uses its own ACME client to communicate with Let's Encrypt, a free Certificate Authority, to validate a domain's DNS records.
73
+
74
+
Let's Encrypt provides several [challenge types](https://letsencrypt.org/docs/challenge-types/) to validate a domain, including the [DNS-01 challenge](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge). At a high level, this challenge requires that either:
75
+
76
+
- A `TXT` record must be placed at `_acme-challenge.<YOUR_DOMAIN>`
77
+
- Or, a `CNAME` record must be placed at `_acme-challenge.<YOUR_DOMAIN>` that points to another domain with the `TXT` record
78
+
79
+
Because Pomerium owns the `pomerium.app` subdomain, we can write the `TXT` record for you. All you need to do is point a **wildcard CNAME record** to your cluster's starter domain.
0 commit comments