Skip to content

Commit

Permalink
Custom domains.
Browse files Browse the repository at this point in the history
  • Loading branch information
matheusgr committed Oct 31, 2023
1 parent 1ee965d commit c28b499
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 22 deletions.
53 changes: 43 additions & 10 deletions docs/getting-started/custom-domains/en.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,30 +29,63 @@ To add a domain:
- The user needs to be an administrator of the site.
- The user needs to acquire a custom domain from a name server provider that allows `CNAME` configuration.
- The user or administrator of the custom domain needs to create a `CNAME` record as indicated in the validation step.
- ONLY if the domain already has any "CAA" records, it is necessary to add new records.

## Before adding a domain

Additional configuration may be required on your website depending on the integration used.

If the domain has a `CAA` record, you need to add new domains so that we can generate the certificate for your new domain. Important: `If your domain doesn't have CAA records, this step is not necessary (and not recommended)`.

You can check if the domain has these records using the [Google Admin Toolbox Dig](https://toolbox.googleapps.com/apps/dig/#CAA/) or the command `dig yourdomain.com.br caa +short`. If the query doesn't return data (`Record not found!`), skip this step.

If your site has certificates, you need to add the following records, especially the last two (`pki.goog`). Add them to your site's domain (or use `@` as the field name).

```
0 issue "digicert.com; cansignhttpexchanges=yes"
0 issuewild "digicert.com; cansignhttpexchanges=yes"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog; cansignhttpexchanges=yes"
0 issuewild "pki.goog; cansignhttpexchanges=yes"
```

Some domain providers do not accept CAA with `cansignhttpexchanges`. In that case, configure it without this property:

```
0 issue "digicert.com"
0 issuewild "digicert.com"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog"
0 issuewild "pki.goog"
```

Check with your domain provider for further instructions on how to add these records.

## Adding a domain in the admin panel

1. Go to the home page of the site and navigate to the Settings tab.

!["Site home"](https://github.com/deco-sites/starting/assets/882438/c95da5f4-75a8-42ed-b747-674157c52c80)
![Site settings](https://github.com/deco-cx/apps/assets/882438/7c60ddbd-7164-42ea-bd16-d8c5d70603df)

2. In Settings, under the Domains listing, check that there is a `deco.site` domain and add an existing domain.

!["Settings tab"](https://github.com/deco-sites/starting/assets/882438/3cf4102a-d9f3-49d6-aaa0-8aeac5e064b6)
2. In Settings, under the Domains listing, check that there is a `deco.site` domain and add an existing domain. **Contact us if you don't have a `deco.site` domain**.

3. Add your domain for the site in the opened modal. The domain should only be the name, without any protocol (http/https) or slashes. Wait for the initial configuration process.

!["Add domain"](https://github.com/deco-sites/starting/assets/882438/4b2a6b1e-a711-4733-9779-367ac0141e41)
![Add domain](https://github.com/deco-cx/apps/assets/882438/8c19ae5c-e522-4a60-9b8b-28e4815cced6)

4. After adding, the domain is registered with Deco but is not yet operational. You now need to set up the domain. Under `...`, click on setup to view the configuration instructions.

!["Domain setup"](https://github.com/deco-sites/starting/assets/882438/ac14645d-6f59-45cf-ae6e-c918eec7247f)

5. Add the domain configuration to your domain server. This represents a `CNAME` record from the custom domain to the deco domain. In the example, this would be a record from the domain `example.dirlididi.org` to `test-fashionmgr.deco.site`.
5. Add the domain configuration to your domain server. This represents a `CNAME` record from the custom domain to the deco domain. In the example, this would be a record from the domain `www.example.com` to `startest.deco.site`.

![CNAME configuration](https://github.com/deco-sites/starting/assets/882438/98f2505f-db78-42e8-9c5c-5350360f7495)
![Domain setup](https://github.com/deco-cx/apps/assets/882438/0d9d876e-2a5e-4e05-8767-dc77e69c548b)

6. Once configured, click on validate configuration for Deco to verify if the record was set up correctly. The certificate configuration step may fail, but if that happens, it will be retried in the background.
6. Once configured, click on validate configuration for Deco to verify if the record was set up correctly. Important: The domain will remain in an "awaiting" state until we complete the configuration on our infrastructure.

7. Wait a few minutes and test accessing your domain in the browser.

Expand Down
56 changes: 44 additions & 12 deletions docs/getting-started/custom-domains/pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,39 +29,71 @@ Para adicionar um domínio:
- o usuário precisa ser administrador do site
- o usuário precisa contratar um domínio próprio em um servidor de nomes que permita configuração de `CNAME`
- o usuário ou administrador do domínio próprio precisa criar um apontamento `CNAME` indicado na etapa de validação
- APENAS caso o domínio já tenha algum apontamento `CAA`, é preciso adicionar novos apontamentos

## Adicionando um domínio no admin
## Antes de adicionar um domínio

1. Entre na página inicial do site, e navegue para a aba de Configurações.
Pode ser necessária alguma configuração adicional em seu site dependendo da integração utilizada.

Caso o domínio tenha algum apontamento `CAA`, é preciso adicionar novos domínios para que possamos gerar o certificado do seu novo domínio. Importante: `caso seu domínio não tenha apontamentos CAA, esta etapa não é necessária (e não é recomendada)`.

É possível verificar se o domínio tem esses apontamentos através da ferramenta [Google Admin Toolbox Dig](https://toolbox.googleapps.com/apps/dig/#CAA/) ou o comando `dig seudominio.com.br caa +short`. Caso a consulta não retorne dados (`Record not found!`), ignore esta etapa.

Caso seu site tenha certificados, é preciso adicionar os registros abaixo, especialmente os dois últimos (`pki.goog`). Adicione no domínio do seu site (ou `@` como nome do campo).

```
0 issue "digicert.com; cansignhttpexchanges=yes"
0 issuewild "digicert.com; cansignhttpexchanges=yes"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog; cansignhttpexchanges=yes"
0 issuewild "pki.goog; cansignhttpexchanges=yes"
```

!["Home do site"](https://github.com/deco-sites/starting/assets/882438/c95da5f4-75a8-42ed-b747-674157c52c80)
Alguns provedores de domínios não aceitam o CAA com `cansignhttpexchanges`, neste caso, configure sem essa propriedade:

2. Em Configurações, na listagem de Domínios, verifique que há um domínio `deco.site` e adicione um domínio existente.
```
0 issue "digicert.com"
0 issuewild "digicert.com"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog"
0 issuewild "pki.goog"
```

!["Aba de configurações"](https://github.com/deco-sites/starting/assets/882438/3cf4102a-d9f3-49d6-aaa0-8aeac5e064b6)
Veja mais instruções no seu provedor de domínios em como adicionar esses campos.

## Adicionando um domínio no admin

1. Entre na página inicial do site, e navegue para a aba de Configurações.

![Configuraçãos do site](https://github.com/deco-cx/apps/assets/882438/7c60ddbd-7164-42ea-bd16-d8c5d70603df)

2. Em Configurações, na listagem de Domínios, verifique que há um domínio `deco.site` e adicione um domínio existente. **Caso não tenha um domínio `deco.site`, entre em contato conosco**.

3. Adicione o domínio próprio do site no modal aberto. O domínio deve ser apenas o nome, sem protocolo (http/https) ou barras. Aguarde o processo de configuração inicial.

!["Adicionar domínio"](https://github.com/deco-sites/starting/assets/882438/4b2a6b1e-a711-4733-9779-367ac0141e41)
![Adicionar domínio](https://github.com/deco-cx/apps/assets/882438/8c19ae5c-e522-4a60-9b8b-28e4815cced6)

4. Depois da adição, o domínio está registrado na deco, mas ainda não é operante. É preciso agora fazer o setup do domínio. Em `...`, clicando em setup, haverá instruções de configuração.

!["Validação do domínio"](https://github.com/deco-sites/starting/assets/882438/ac14645d-6f59-45cf-ae6e-c918eec7247f)

5. Adicione a configuração de domínio no seu servidor de domínios. Isto representa um apontamento `CNAME` do domínio própio, para o domínio da deco. No exemplo, isto representa um apontamento do domínio `example.dirlididi.org` para `test-fashionmgr.deco.site`.
5. Adicione a configuração de domínio no seu servidor de domínios. Isto representa um apontamento `CNAME` do domínio própio, para o domínio da deco. No exemplo, isto representa um apontamento do domínio `www.example.com` para `startest.deco.site`.

![Configuração do CNAME](https://github.com/deco-sites/starting/assets/882438/98f2505f-db78-42e8-9c5c-5350360f7495)
![Validação do domínio](https://github.com/deco-cx/apps/assets/882438/0d9d876e-2a5e-4e05-8767-dc77e69c548b)

6. Uma vez configurado, clique em validar configuração para que a deco valide se o apontamento foi corretamente realizado. A etapa de configuração de certificados pode falhar, mas, caso isso ocorra, será tentada novamente em background.
6. Uma vez configurado, clique em validar configuração para que a deco valide se o apontamento foi corretamente realizado. **Importante: O domínio continuará no estado de em espera por validação até que o apontamento seja realizado na nossa infraestrutura**.

7. Aguarde alguns minutos e teste acessar seu domínio no browser.

# Erros Comuns

## O domínio não é validado

Verifique se o mesmo foi cadastrado corretamente no servidor de nomes. Use uma ferramenta como o ][DNS da google](https://dns.google/) para verificar se há um registro de `CNAME` apontando o domínio corretamente para um domínio `deco.site`.
Verifique se o mesmo foi cadastrado corretamente no servidor de nomes. Use uma ferramenta como o ][DNS da google](https://dns.google/) para verificar se há um registro de `CNAME` apontando o domínio corretamente para um domínio `deco.site`. Alguns provedores de domínios podem levar até 12 horas para efetivar o novo apontamento.

## Após a validação, as configurações ainda exibem meu domínio como "Awaiting"

Expand Down

0 comments on commit c28b499

Please sign in to comment.