Pular para o conteúdo principal

Configurar marca e domínio

Seus clientes acessam a plataforma pelos seus domínios, não pelos da EdgeX. Cada tenant tem até quatro:

DomínioExemploO que serveObrigatório
Consolecloud.suaempresa.com.brO console em que seus clientes entram.Sim
APIapi.suaempresa.com.brA API, para integrações com API Key.Não
Documentaçãodocs.suaempresa.com.brA documentação para os seus clientes, com a sua marca.Não
Documentação da organizaçãoorg.docs.suaempresa.com.brA documentação para a sua equipe: white label e administração.Não

O console não precisa do domínio de API: ele fala com a plataforma pelo próprio domínio. O domínio de API só importa se você ou seus clientes integram direto com a API.

Regras para os nomes​

  • O domínio da documentação precisa começar com docs., e o da documentação da organização, com org.docs.. É por esse prefixo que a plataforma diferencia um site de documentação de um console, então um nome como ajuda.suaempresa.com.br é recusado.
  • O domínio do console não pode começar com docs. nem com org.docs., senão o visitante recebe a documentação no lugar do console.
  • Cada domínio pertence a um tenant só.

Aponte o DNS​

Antes do cadastro, cada domínio precisa apontar para a plataforma:

DomínioAponte para
Console, documentação e documentação da organizaçãoO endereço do console da plataforma, informado pela EdgeX
APIO endereço da API da plataforma, informado pela EdgeX

Um registro CNAME é o caminho mais simples. Use um registro A só se o seu provedor de DNS não permitir CNAME naquele nome.

Certificados​

Não há nada para enviar. O certificado de cada domínio é emitido sozinho no primeiro acesso, assim que o DNS aponta para a plataforma e o domínio está cadastrado no seu tenant. Esse primeiro acesso pode levar alguns segundos a mais. Um domínio que não está cadastrado em nenhum tenant nunca ganha certificado.

Cadastre os domínios​

Ainda não há tela para isso no console. Envie a lista de domínios ao suporte da EdgeX: eles passam a funcionar assim que estiverem cadastrados e o DNS apontar para a plataforma.

O que seus clientes veem​

  • O console no seu domínio de console, com a sua marca.
  • Os links Learn more do console abrem o seu domínio de documentação. Enquanto você não tiver um, abrem a documentação da EdgeX.
  • A documentação no seu domínio, com as suas cores, logo e nome.

Marca​

Em construção

A parte de cores, logo e banner de login está sendo escrita. Volte em breve.