Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Add first batch of Cloud docs (#36218)
Co-authored-by: Dustin Schau <DSchau@users.noreply.github.com> Co-authored-by: Lennart <lekoarts@gmail.com> Co-authored-by: Patrick Sullivan <sully317@gmail.com> Co-authored-by: pragmaticpat <72818141+pragmaticpat@users.noreply.github.com>
- Loading branch information
4 people
committed
Aug 8, 2022
1 parent
4238142
commit 2be3fa7
Showing
24 changed files
with
455 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| title: Adding a Custom Domain to Your Site on Gatsby Cloud | ||
| description: Learn how to add a custom domain to your site on Gatsby Cloud | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Gatsby Cloud allows you to specify Custom Domains for your Gatsby websites. This guide provides the steps for applying Custom Domains to your sites on Gatsby Cloud. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you can add a custom domain, you'll need to be hosting with Gatsby Cloud. If you haven't already, [turn on Gatsby Hosting](https://support.gatsbyjs.com/hc/en-us/articles/360061641114). | ||
|
|
||
| ## Directions | ||
|
|
||
| ### 1. Add a domain | ||
|
|
||
| 1. Go to Site Settings > Hosting. | ||
| 1. Click **"Add Domain"** above the domain list to start the process | ||
|  | ||
| 1. In the **"Please enter a domain"** field, add one of the following: | ||
|
|
||
| - your apex or root domain (this is your custom domain without the www. part, e.g. mysite.com) | ||
| - your subdomain (e.g., www.mysite.com or store.mysite.com) | ||
|  | ||
|
|
||
| Whichever one you choose will become the primary domain for your site. | ||
|
|
||
| #### Redirect to the primary domain | ||
|
|
||
| If you add an apex domain, Gatsby Hosting will automatically add a redirect that points the www. subdomain to the apex domain. Similarly, if you add a www. subdomain, Gatsby Hosting will automatically add a redirect that points the apex domain to it. Read more about redirected domains in [Working with Redirected Domains](https://support.gatsbyjs.com/hc/en-us/articles/1500003051241). | ||
|
|
||
| ### 2. Configure your domain name system (DNS) | ||
|
|
||
| Next you'll need to visit your 3rd party DNS registrar (e.g. GoDaddy, NameCheap, etc.) to add some DNS records. A DNS Record is an entry in a DNS with details about how to route a request for a given domain name. | ||
|
|
||
| #### Apex domain configuration | ||
|
|
||
| If you added an apex domain, you will need to add an Address Mapping Record (A Record). | ||
|
|
||
| 1. Copy one of the IP addresses from the "Value" column for the A records shown next to your custom domain. | ||
| 1. In your DNS provider's domain settings, create an A Record for the IP address you chose. | ||
|  | ||
|
|
||
| The A Record must point to one of the IP addresses shown for your site. It is only necessary to create an A Record for one of the IP addresses listed. | ||
|
|
||
| #### Subdomain configuration | ||
|
|
||
| If you added a subdomain, you will need to add a Canonical Name Record (CNAME). The CNAME record must point to the default domain for your site. | ||
|  | ||
|
|
||
| #### How to add DNS records for popular registrars | ||
|
|
||
| Here's documentation on adding DNS records for some popular name registrars: | ||
|
|
||
| - Go Daddy: [A Record](https://www.godaddy.com/help/add-an-a-record-19238) | [CNAME](https://www.godaddy.com/help/add-a-cname-record-19236) | ||
| - Name.com: [A Record](https://www.namecheap.com/support/knowledgebase/article.aspx/319/2237/how-can-i-set-up-an-a-address-record-for-my-domain/) | [CNAME](https://www.namecheap.com/support/knowledgebase/article.aspx/9646/2237/how-to-create-a-cname-record-for-your-domain/) | ||
| - NameCheap: [A Record](https://www.name.com/support/articles/115004893508-Adding-an-A-record) | [CNAME](https://www.name.com/support/articles/115004895548-Adding-a-CNAME-Record) | ||
| - Google Domains: [A Record](https://support.google.com/a/answer/2579934?hl=en&ref_topic=2721296) | [CNAME](https://support.google.com/a/answer/47283) | ||
|
|
||
| ## 3. Check DNS status | ||
|
|
||
| Once you've added your DNS record, click **"Check Status"** or refresh the page to check that your DNS record has been recognized by Gatsby Hosting. | ||
|  | ||
|
|
||
| If your domain fails to validate after 24 hours, try creating an A Record for one of the other IP addresses available instead. | ||
|  | ||
|
|
||
| ## 4. Generate SSL certificate | ||
|
|
||
| After the domain is validated, we'll generate a free SSL certificate via Let's Encrypt and automatically configure it. This whole process can take a few minutes to complete. | ||
|  | ||
|
|
||
| **Note**: DNS records need to be fully propagated in order to properly verify the certificates. If not, SSL certification generation will fail. | ||
|
|
||
| ## 5. Finish | ||
|
|
||
| Once your custom domain has the **"HTTPS On"** label next to it, you should be able to visit it to see your site live. | ||
|  | ||
|
|
||
| If you encounter errors related to the the connection not being secure, please allow a few minutes as it can take time for DNS changes to take effect and be detected by all browsers. Use this time to verify that you followed the above steps completely. | ||
|
|
||
| ## Other considerations | ||
|
|
||
| If you see the following when you visit your custom domain, the site may still be building. | ||
|  | ||
|
|
||
| Check the **"Deploys"** tab for your site to see the current status of your builds. | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.