Domínios e e-mail

O seu ambiente responde em dois nomes de host: um para a API e as telas de login hospedadas, que também é o emissor de todo token, e outro para o console. Configuração → Domínio mostra os endereços em uso e de onde eles vêm, e é onde você leva o ambiente para um domínio próprio.

Endereços em uso

O seu domínio próprio, quando ativo, tem prioridade sobre o subdomínio da plataforma, que tem prioridade sobre os endereços do provedor de hospedagem. O <nome> de um subdomínio da plataforma vem do nome da sua conta — letras minúsculas, dígitos e hífens, até 24 caracteres —, com um número acrescentado quando outro ambiente já o usa.

O endereço da API é onde fica o emissor de cada realm. Com auth.acme.com ativo, o emissor do realm acme é:

https://auth.acme.com/realms/acme

Usando um domínio próprio

Você precisa de dois nomes de host sob o mesmo domínio — auth.acme.com e console.acme.com sob acme.com —, porque as passkeys ficam vinculadas ao domínio que os dois compartilham. Eles precisam ser diferentes entre si e não podem ficar sob o domínio da própria plataforma. Dá para registrar um domínio próprio por vez, e o ambiente precisa estar pronto.

1. 1

   Adicione o domínio

   Em Configuração → Domínio, em Seu próprio domínio, informe o host da API e das telas de login e o host do console — só os nomes de host, sem https:// nem caminho — e escolha Adicionar domínio.

2. 2

   Crie os registros DNS

   A página lista cada registro a criar no seu provedor de DNS, com nome, tipo e valor para copiar: um registro de roteamento para cada host — normalmente um CNAME — e, quando o provedor de hospedagem pede, um registro TXT que prova que o host é seu. Por exemplo:

   Nome	Tipo	Valor
   auth.acme.com	CNAME	O que o console mostrar
   console.acme.com	CNAME	O que o console mostrar
   _railway-verify.auth.acme.com	TXT	O que o console mostrar
   _railway-verify.console.acme.com	TXT	O que o console mostrar

   Cada registro fica Encontrado quando o DNS responde com o valor esperado, ou Precisa de ajuste quando responde com outro. A página confere de novo a cada 30 segundos.

3. 3

   Aguarde os certificados

   Quando os registros de um host respondem, um certificado é emitido para ele, o que pode levar de alguns minutos a algumas horas. Com os dois certificados emitidos, o domínio fica Pronto para ativar.

4. 4

   Ative o domínio

   Escolha Ativar domínio quando as aplicações integradas ao endereço atual estiverem prontas para mudar. A API e o console passam por um novo deploy com os endereços novos, e o domínio fica Em uso.

O que a ativação muda

• O emissor passa para o novo endereço da API. Tokens assinados com o emissor antigo deixam de valer, então todo mundo que está conectado entra de novo.
• As aplicações integradas ao endereço antigo precisam ser atualizadas para o novo emissor, ou os logins delas falham.
• As passkeys ficam vinculadas ao domínio em que foram cadastradas, então as cadastradas nos endereços anteriores não aparecem nos novos; as pessoas as cadastram de novo.
• Os registros DNS precisam continuar no lugar: apagá-los tira o ambiente destes endereços.

Removendo o seu domínio

Remover domínio esquece o domínio. Se ele estava em uso, o ambiente volta para o subdomínio da plataforma — ou para o endereço do provedor de hospedagem, onde não houver subdomínio — e a API e o console passam por um novo deploy. O emissor também volta, então todo mundo entra de novo e as aplicações integradas precisam voltar a apontar para esse endereço. Os registros no seu provedor de DNS continuam lá até você apagá-los.

Como o ambiente envia e-mail

O seu ambiente envia e-mail para recuperação de senha, códigos de login e convites, entre outros. Ele começa enviando pela conta do MailerSend e pelo remetente da própria plataforma, para a recuperação de senha funcionar desde o primeiro minuto — inclusive a renovação por e-mail que os administradores do realm authio usam quando a senha deles expira.

Para cada e-mail, o ambiente usa o primeiro envio que estiver configurado:

1. Uma chave do MailerSend ou do SendGrid definida nas configurações de e-mail do client a que o e-mail pertence.
2. A EMAIL_MAILERSEND_APIKEY do ambiente — a chave da plataforma, por padrão.
3. O seu servidor SMTP, pelas variáveis EMAIL_SMTP_*.

Por isso, o SMTP só é usado depois que a EMAIL_MAILERSEND_APIKEY é removida.

Enviando pelo seu próprio e-mail

1. 1

   Abra as variáveis de e-mail

   Em Configuração → Variáveis, encontre o grupo E-mail. Só um proprietário ou administrador da conta pode alterá-lo.

2. 2

   Defina o remetente

   Defina EMAIL_FROM_NAME e EMAIL_FROM_ADDRESS com o nome e o endereço de onde os seus e-mails devem sair. O endereço precisa ser um que o seu servidor tenha permissão para usar.

3. 3

   Preencha o seu servidor SMTP

   Defina EMAIL_SMTP_HOST, EMAIL_SMTP_PORT (normalmente 587, ou 465 para SSL), EMAIL_SMTP_USERNAME, EMAIL_SMTP_PASSWORD e EMAIL_SMTP_ENABLESSL.

4. 4

   Remova a chave da plataforma

   Escolha Remover na EMAIL_MAILERSEND_APIKEY. Enquanto ela estiver definida, o MailerSend tem prioridade sobre o SMTP.

5. 5

   Salve e confira

   Escolha Salvar e refazer o deploy. A API passa por um novo deploy com as configurações novas em poucos minutos; depois, peça uma recuperação de senha para o seu próprio usuário e veja o e-mail chegar.

Para continuar no MailerSend com a sua própria conta, substitua a EMAIL_MAILERSEND_APIKEY pela sua chave e defina EMAIL_FROM_ADDRESS com um endereço num domínio verificado nessa conta do MailerSend.

Próximos passos