diff --git a/doc/static/custom-domains/change-to-nameservers.png b/doc/static/custom-domains/change-to-nameservers.png new file mode 100644 index 00000000..3d91aa7c Binary files /dev/null and b/doc/static/custom-domains/change-to-nameservers.png differ diff --git a/doc/static/custom-domains/custom-domains-section.png b/doc/static/custom-domains/custom-domains-section.png index 527ce9d4..b6e18a60 100644 Binary files a/doc/static/custom-domains/custom-domains-section.png and b/doc/static/custom-domains/custom-domains-section.png differ diff --git a/doc/static/custom-domains/namecheap-advanced-dns.png b/doc/static/custom-domains/namecheap-advanced-dns.png new file mode 100644 index 00000000..7e5c0246 Binary files /dev/null and b/doc/static/custom-domains/namecheap-advanced-dns.png differ diff --git a/doc/static/custom-domains/namecheap-domains.png b/doc/static/custom-domains/namecheap-domains.png index 888c6242..fc64f4f3 100644 Binary files a/doc/static/custom-domains/namecheap-domains.png and b/doc/static/custom-domains/namecheap-domains.png differ diff --git a/doc/static/custom-domains/namecheap-updated-dns-records.png b/doc/static/custom-domains/namecheap-updated-dns-records.png new file mode 100644 index 00000000..8da32cdf Binary files /dev/null and b/doc/static/custom-domains/namecheap-updated-dns-records.png differ diff --git a/doc/static/custom-domains/nameservers.png b/doc/static/custom-domains/nameservers.png new file mode 100644 index 00000000..404e1e46 Binary files /dev/null and b/doc/static/custom-domains/nameservers.png differ diff --git a/doc/static/custom-domains/pointing-change-dns-records.png b/doc/static/custom-domains/pointing-change-dns-records.png new file mode 100644 index 00000000..46420082 Binary files /dev/null and b/doc/static/custom-domains/pointing-change-dns-records.png differ diff --git a/doc/static/custom-domains/verified.png b/doc/static/custom-domains/verified.png index 06254809..5c588bbd 100644 Binary files a/doc/static/custom-domains/verified.png and b/doc/static/custom-domains/verified.png differ diff --git a/doc/user-guide/custom-domains.md b/doc/user-guide/custom-domains.md index 659f3e2f..a49d810c 100644 --- a/doc/user-guide/custom-domains.md +++ b/doc/user-guide/custom-domains.md @@ -2,9 +2,9 @@ When you publish your application for the first time, your web address (i.e., URL) is in the following format: `project-id.plooberapp.io` -If you already own a domain, you can easily bring it to your Ploomber account by changing its name servers. With this connection method, Ploomber hosts your DNS, while your domain remains registered with its current host. +If you already own a domain, you can easily bring it to your Ploomber account by updating your DNS records, or by changing its nameservers. -## Ading a custom domain +## Adding a custom domain ### Before you begin @@ -26,13 +26,62 @@ Next, in **Custom domains** section, enter your domain name and click `Connect`. ![](../static/custom-domains/custom-domains-section.png) +### Choose your connection method -To complete the process, update the name server settings for your domain in your hosting account with the newly provided name servers +There are two ways to connect a custom domain. Depending on where you want to store your DNS records, choose the method that suits you: -![](../static/custom-domains/pending-validation.png) +* **Pointing** (default) - Your domain host stores your DNS records on their platform +* **Nameservers** - We host your DNS records -### How to change your domain's nameservers? +#### Method 1: Pointing + +To complete the process, you need to add the following DNS records in your domain host account. If these records already exist, you need to replace them with the newly provided DNS records. + +![](../static/custom-domains/pointing-change-dns-records.png) + +```{note} +Please make sure to add the SSL record so we'll be able to request the SSL certificate for you. +``` + +##### How to change your DNS records? + +In most cases, changing your DNS records is a simple and easy process. + +We will cover the instructions for updating your records on Namecheap. While it may be a slightly different process, the basic steps remain the same for any other domain registrar. + +1. Log in to your [Namecheap account](https://www.namecheap.com/) + +2. Click `Domain List` tab and then click `Manage` button next to your domain + +![](../static/custom-domains/namecheap-domains.png) + +3. Click `Advanced DNS` + +![](../static/custom-domains/namecheap-advanced-dns.png) + +4. Add the relevant DNS records, and click `Save all changed`. + +You should be able to see something like this: + +![](../static/custom-domains/namecheap-updated-dns-records.png) + + +You've completed the process, and now it's time to be patient. Allow up to 48 hours for your domain's updated DNS records to propagate, enabling your application to become accessible worldwide. + +#### Method 2: Nameservers + +First, let's change the connection method to nameservers, by clicking `nameservers`. + +![](../static/custom-domains/change-to-nameservers.png) + + +Now, update the name server settings for your domain in your hosting account with the newly provided name servers. + +![](../static/custom-domains/nameservers.png) + + +##### How to change your domain's nameservers? In most cases, changing your nameserver is a simple and easy process. @@ -58,8 +107,9 @@ We will cover the instructions for changing your nameservers on Namecheap. While It can take up to 48 hours for nameserver changes to take effect. Please be patient if your website isn’t showing up at your domain right away. ``` -### HTTPS and SSL +#### HTTPS and SSL -All Ploomber applications include the HTTPS and SSL protocols, ensuring that communication between your visitors and your site is entirely secure. Once your custom domain has been verified, you'll be able to see it under Registered domains as `issued`, and your custom domain will have an SSL certification. +All Ploomber applications include the HTTPS and SSL protocols, ensuring that communication between your visitors and your site is entirely secure. Once your custom domain has been verified, you'll be able to see it under Registered domains as `ISSUED`, and your custom domain will have an SSL certification. ![](../static/custom-domains/verified.png) +