Skip to content
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

Custom DNS pointing method added #65

Merged
merged 5 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/custom-domains/custom-domains-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/custom-domains/namecheap-domains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/custom-domains/nameservers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/static/custom-domains/verified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 57 additions & 7 deletions doc/user-guide/custom-domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand All @@ -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)