Visão geral da implantação
Opções de hospedagem para sua documentação: subdomínio Jamdesk, domínio personalizado com SSL ou subcaminho /docs via proxy reverso no site existente.
O Jamdesk implanta sua documentação automaticamente em um subdomínio *.jamdesk.app. Quando estiver pronto para publicar em seu próprio domínio, você poderá escolher um subdomínio personalizado (como docs.example.com) ou hospedar a documentação em um subcaminho do seu site principal: /docs por padrão ou qualquer segmento personalizado à sua escolha.
Opções de implantação
| Opção | Ideal para | Complexidade de configuração |
|---|---|---|
Subdomínio Jamdesk (your-project.jamdesk.app) | Publicação mais rápida, sem trabalho com DNS | Baixa |
Subdomínio personalizado (docs.example.com) | Documentação de produção com sua marca | Média |
Hospedagem em subcaminho (example.com/docs, personalizável) | Manter a documentação no domínio principal | Alta |
Hospedagem padrão (sem configuração)
Todo projeto fica disponível em um subdomínio Jamdesk assim que você conecta um repositório. Essa é a opção mais simples para documentação interna, prévias ou lançamentos iniciais.
Domínio personalizado (subdomínio)
Use seu próprio subdomínio (por exemplo, docs.example.com) para ter uma URL pública associada à sua marca. Você adicionará registros DNS e verificará a propriedade no dashboard do Jamdesk.
A verificação de DNS e o SSL são gerenciados automaticamente assim que os registros são configurados. Consulte Domínios personalizados para ver as instruções de configuração.
Hospedagem em subcaminho
Hospede a documentação em um subcaminho do seu domínio encaminhando o tráfego para o Jamdesk por proxy: example.com/docs por padrão ou um segmento personalizado, como example.com/help. Use essa opção quando quiser que a documentação fique sob o domínio principal de marketing.
A hospedagem em subcaminho requer uma camada de proxy ou CDN para encaminhar as solicitações e definir o cabeçalho X-Jamdesk-Forwarded-Host. Consulte Hospedagem em subcaminho.
Exemplo de configuração de proxy (nginx)
location /docs {
proxy_pass https://YOUR_SLUG.jamdesk.app;
proxy_set_header X-Jamdesk-Forwarded-Host $host;
}
location /_next/ {
proxy_pass https://YOUR_SLUG.jamdesk.app;
}
location /_jd/ {
proxy_pass https://YOUR_SLUG.jamdesk.app;
}
Para ver uma configuração completa com SSL, cabeçalhos e orientações específicas do provedor, consulte o guia de Hospedagem em subcaminho.
Guias por provedor
Escolha sua infraestrutura para implementar a hospedagem em subcaminho: