---
title: Hospedagem em subcaminho
description: Hospede sua documentação em um subcaminho do domínio, como yoursite.com/docs, com configurações para Vercel, CloudFront, Cloudflare e proxy reverso.
---
> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.
Hospede sua documentação em um subcaminho do domínio, em vez de usar um subdomínio separado: `yoursite.com/docs` por padrão ou um segmento personalizado, como `yoursite.com/help`. Para ver todas as opções de implantação, consulte [Visão geral da implantação](/pt/deploy/overview).
As capturas de tela mostram a interface em inglês.
## Por que usar um subcaminho?
Em comparação com um subdomínio, como `docs.yoursite.com`, um subcaminho mantém os leitores no seu domínio principal, e suas páginas de documentação contribuem para a autoridade de busca desse domínio, em vez de dividir os sinais de classificação entre dois hosts.
## Como funciona
Seu servidor web ou CDN faz proxy das solicitações de `/docs/*` para o seu site Jamdesk, preservando a URL original no navegador:
```mermaid
sequenceDiagram
participant User
participant Proxy as Your Proxy
participant Jamdesk as [slug].jamdesk.app
User->>Proxy: GET yoursite.com/docs/getting-started
Proxy->>Jamdesk: Forward with X-Jamdesk-Forwarded-Host: yoursite.com
Jamdesk-->>Proxy: HTML response
Proxy-->>User: Served with yoursite.com/docs URLs
```
O proxy transmite o cabeçalho `X-Jamdesk-Forwarded-Host` com o seu domínio. O Jamdesk usa esse cabeçalho para:
1. **Verificar se seu domínio** está autorizado a fornecer o conteúdo
2. **Aplicar sua configuração** do dashboard
Isso torna a configuração do proxy uma operação única: se você alterar as configurações no dashboard, não será necessário atualizar o proxy.
## Configuração por provedor
Escolha seu provedor de hospedagem para começar:
Use o Cloudflare Workers para fazer proxy do tráfego de /docs
Configure o CloudFront com o Route 53
Adicione rewrites ao vercel.json
nginx, Apache ou outros servidores proxy
## Pré-requisitos
Antes de configurar seu proxy:
1. **Adicione seu domínio** no seu [dashboard do Jamdesk](https://dashboard.jamdesk.com), em Settings → Custom Domain
2. **Ative "Host at a subpath"**
3. **Escolha seu subcaminho** (opcional; consulte [Escolhendo seu subcaminho](#escolhendo-seu-subcaminho) abaixo) e clique em **Save**
Seu subdomínio do Jamdesk (por exemplo, `acme.jamdesk.app`) será exibido no dashboard. Você precisará dele para configurar o proxy.
Salvar uma alteração na hospedagem em subcaminho (ativá-la ou desativá-la, ou alterar o próprio subcaminho) aciona uma reconstrução completa da documentação. Isso é necessário porque a estrutura da URL muda (por exemplo, entre `/introduction` e `/docs/introduction`).
## Escolhendo seu subcaminho
Por padrão, sua documentação é disponibilizada em `/docs`. Para usar outro caminho, como `/help` ou `/support`, insira-o no campo de subcaminho ao lado do toggle. Com o campo em branco, o toggle exibe `Host at a subpath (e.g. /docs)`; digite um valor e ele será atualizado em tempo real para o caminho que você está prestes a ativar (`Host at /help` e assim por diante).
O campo aceita um único segmento em letras minúsculas: letras, dígitos e hifens internos בלבד, sem hífen inicial ou final, com no máximo 63 caracteres. Alguns segmentos são reservados e rejeitados imediatamente, incluindo `api`, `jd`, caminhos administrativos comuns, como `wp-admin`, e qualquer código de localidade que sua documentação possa usar (`fr`, `es`, `de` e similares). Reservá-los significa que seu subcaminho nunca poderá entrar em conflito com uma rota já disponibilizada pelo Jamdesk.
Deixe o campo em branco para manter o padrão `/docs`.
## Renomear ou remover seu subcaminho
Alterar seu subcaminho ou apagá-lo para voltar ao padrão é seguro e não quebra links que já foram indexados ou adicionados aos favoritos:
- **`/docs` nunca deixa de ser disponibilizado.** Mesmo depois de mudar para um subcaminho personalizado, como `/help`, os caminhos originais `/docs/*` continuam respondendo no seu subdomínio `[slug].jamdesk.app` e por qualquer proxy que ainda aponte para eles. Os links canônicos mudam imediatamente para o novo subcaminho, para que os mecanismos de busca façam a reindexação nesse local. Nada que já aponte para `/docs` deixa de funcionar, o que permite atualizar a configuração do seu próprio proxy no seu ritmo, sem pressão.
- **Renomear um subcaminho personalizado encaminha o anterior uma vez.** Se você renomear `/help` para `/guide`, as solicitações para `/help/*` serão redirecionadas com o código 308 para o caminho correspondente `/guide/*`. Esse histórico tem apenas um nível: renomeie novamente `/guide` para `/support` e `/guide/*` passará a redirecionar para `/support/*`, mas `/help/*` (o segmento de duas renomeações atrás) não será mais rastreado. Esses links deixarão de ser resolvidos e levarão a uma página de "not found", às vezes após um redirecionamento para um caminho combinado de aparência estranha. Não encadeie renomeações se depender do redirecionamento para preservar links antigos; atualize os links externos para o subcaminho atual.
- **Voltar para `/docs`** funciona da mesma maneira: seu subcaminho personalizado anterior (um nível do histórico) redireciona para `/docs/*`.
Isso **não** significa que `/docs` redireciona para qualquer subcaminho escolhido. Isso não é necessário, pois `/docs` continua sendo disponibilizado diretamente e permanentemente. O redirecionamento de um nível se aplica somente a um subcaminho *personalizado* do qual você está saindo.
Depois de configurar o proxy, faça um teste acessando `https://yoursite.com/docs` (ou o subcaminho configurado). Sua documentação deverá ser carregada com todos os recursos e links funcionando corretamente.
## Preciso ocultar o subdomínio jamdesk.app?
Não. Seu subdomínio `[slug].jamdesk.app` continua acessível (é a origem upstream para a qual seu proxy encaminha as solicitações), mas não competirá com seu site nos resultados de busca:
- **Com seu domínio registrado**, todas as páginas disponibilizadas diretamente pelo subdomínio incluem um link canônico que aponta para a mesma página no seu domínio, para que os mecanismos de busca consolidem todos os sinais de classificação nele.
- **Antes de um domínio ser registrado**, as páginas do subdomínio no modo de subcaminho são marcadas como `noindex`, portanto nunca entram no índice.
Se você também quiser impedir o acesso ao próprio conteúdo no subdomínio (e não apenas evitar sua indexação), ative a [Proteção por senha](/pt/setup/password-protection): o subdomínio exibirá uma tela de desbloqueio em vez da sua documentação.
## O que vem a seguir?
Compare hospedagem em subdomínio, domínio personalizado e subcaminho
Verifique o DNS e resolva problemas na configuração do domínio