Jamdesk Documentation logo

Visão geral da implantação

Opções de hospedagem da sua documentação: subdomínio Jamdesk, domínio personalizado com SSL ou subcaminho /docs atrás do seu site via proxy reverso.

O Jamdesk implanta sua documentação em um subdomínio *.jamdesk.app. Para publicar no seu próprio domínio, escolha um subdomínio personalizado (como docs.example.com) ou um subcaminho do seu site principal. O subcaminho padrão é /docs, ou qualquer segmento personalizado que você escolher.

Opções de implantação

OpçãoMelhor paraComplexidade de configuração
Subdomínio Jamdesk (your-project.jamdesk.app)Lançamento mais rápido, sem trabalho de DNSBaixa
Subdomínio personalizado (docs.example.com)Documentação de produção com sua marcaMédia
Hospedagem em subcaminho (example.com/docs, personalizável)Manter a documentação no domínio principalAlta

Hospedagem padrão (sem configuração)

Todo projeto fica disponível em um subdomínio Jamdesk assim que você conecta um repositório. Use-o para documentação interna, pré-visualizações ou lançamentos iniciais.

Domínio personalizado (subdomínio)

Use seu próprio subdomínio (por exemplo, docs.example.com) para uma URL pública com a sua marca. Adicione os registros DNS e verifique a propriedade no painel do Jamdesk.

O Jamdesk verifica o DNS e emite o SSL assim que os registros estiverem no lugar. Consulte Domínios personalizados para a configuração.

Hospedagem em subcaminho

Faça o proxy do tráfego para o Jamdesk para hospedar a documentação em um subcaminho do seu domínio. O padrão é example.com/docs, ou escolha um segmento personalizado como example.com/help. Use essa opção para manter a documentação sob o seu domínio de marketing principal.

A hospedagem em subcaminho exige uma camada de proxy ou CDN para encaminhar as requisições e definir o cabeçalho X-Jamdesk-Forwarded-Host. Consulte Hospedagem em subcaminho.

Exemplo de configuração de proxy (nginx)

nginx.conf
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;
}

Consulte o guia Hospedagem em subcaminho para uma configuração completa, com SSL, cabeçalhos e etapas específicas de cada provedor.

Guias por provedor

Escolha o guia para a sua infraestrutura:

Cloudflare

Use Cloudflare Workers para fazer proxy do tráfego de /docs

AWS

Configure o CloudFront com o Route 53

Vercel

Adicione rewrites ou edge middleware

Proxy reverso

nginx, Apache ou outros servidores proxy

Próximos passos?

Ciclo de build e deploy

Como os builds são disparados e implantados

Hospedagem em subcaminho

Hospede a documentação em /docs no seu domínio principal

Domínios personalizados

Configure docs.yourdomain.com

Solução de problemas de DNS

Corrija problemas de propagação e verificação de DNS