Hospedagem de subpastas

A hospedagem de subpastas permite que você sirva seu site da base de conhecimento Document360 a partir de um caminho sob seu domínio principal, como example.com/docs, em vez de um subdomínio separado como docs.example.com. Uma subpasta (ou subdiretório) aparece após o domínio raiz em uma URL e ajuda a estruturar o conteúdo logicamente sob seu site existente. Hospedar documentação em uma subpasta, em vez de um subdomínio, geralmente é melhor para otimização para mecanismos de busca, já que os mecanismos de busca tratam o conteúdo das subpastas como parte da autoridade do seu domínio principal. A hospedagem de subpastas pode ser ativada tanto para domínios fornecidos pelo Document360 quanto para domínios personalizados mapeados.

Quando usar a hospedagem de subpastas

Use hospedagem de subpastas quando quiser que sua documentação fique sob o domínio do seu site existente, em vez de um subdomínio separado.

• Você quer que sua base de conhecimento se beneficie da autoridade de SEO do seu domínio principal, em vez de construir autoridade separadamente em um subdomínio.
• Sua marca ou diretrizes de marketing exigem que todo o conteúdo voltado para o cliente esteja sob um único domínio raiz.
• Você quer uma URL como example.com/help em vez de help.example.com.

Antes de começar

Você também precisará de acesso à configuração do seu servidor web (Nginx, Apache, IIS ou ASP.NET Core) para fazer requisições proxy para o Document360, já que hospedagem de subpastas requer configuração do lado do servidor fora do próprio Document360.

Como habilitar a hospedagem de subpastas

1. Navegue até Configurações > Site da base de conhecimento na barra de navegação esquerda da Portal da base de conhecimento.
2. Navegue até Domínio personalizado.
3. Na página de domínio personalizado , navegue até a Hospedagem de subpastas . Por padrão, o caminho da Subpasta está definido como /docs.
4. Ative a opção ao lado de Knowledge Base está hospedada como uma subpasta.

Quando essa opção está ativada, a prévia pública dos artigos fica visível, e o slug do workspace não é mais inserido automaticamente quando você adiciona links nos artigos.

A hospedagem de subpastas agora está habilitada para o seu projeto.

Como definir um caminho de subpasta personalizado

Você pode hospedar sua base de conhecimento em um caminho de subpasta diferente de /docs, como /help ou /support.

1. Navegue até Configurações > Site da base de conhecimento na barra de navegação esquerda da Portal da base de conhecimento.
2. Navegue até Domínio personalizado.
3. Na página de domínio personalizado , navegue até a Hospedagem de subpastas .
4. Limpe o campo de caminho da Subpasta e insira seu caminho personalizado, por /helpexemplo.
5. Clique Atualização .

Ao configurar um caminho diferente do padrão, também considere as linguagens associadas a cada workspace no seu projeto; A configuração do servidor para isso varia conforme o servidor web. Sua subpasta personalizada só entra em vigor quando a hospedagem de subpastas estiver habilitada, e seu servidor deve estar configurado para fazer proxy requests para esse caminho — veja os artigos específicos do servidor da plataforma para orientações.

Como definir um caminho personalizado para a API do Site

Por padrão, o caminho da API do Site é definido como /api. Você pode personalizar isso a partir da mesma aba de hospedagem de Subpastas — por exemplo, para /docs-api ou /api-docs, se /api já for usado por outra aplicação no seu domínio.

1. Navegue até Configurações > Site da base de conhecimento na barra de navegação esquerda da Portal da base de conhecimento.
2. Navegue até Domínio personalizado.
3. Na página de domínio personalizado , navegue até a Hospedagem de subpastas . Por padrão, o caminho da API do Site está definido como /api.
4. Limpe o campo de caminho da API do site e insira seu caminho personalizado, por /docs-apiexemplo.
5. Clique Atualização .

Após definir o caminho da API do Site, configure um bloco de localização correspondente no seu servidor web e garanta que o valor inserido aqui corresponda exatamente ao caminho na configuração do proxy reverso do seu servidor. Consulte o guia específico de servidores para cada plataforma para exemplos:

O que acontece a seguir

Depois que seu servidor web está configurado, seu site da Knowledge Base fica ativo na sua subpasta personalizada. No entanto, a URL existente do Document360 continua a atender solicitações também — por exemplo, tanto example.document360.io example.com/docs quanto apontará para o site da sua base de conhecimento. Isso causa conteúdo duplicado em mecanismos de busca como Google e Bing.

Para evitar conteúdo duplicado, ative a opção Restringir acesso a subdomínio em Configurações > Site da base de conhecimento > Domínio personalizado > Hospedagem de subpastas. Certifique-se de que um domínio canônico esteja configurado antes de ativar essa opção — uma vez ativado, seu subdomínio Document360 redireciona automaticamente para seu domínio canônico.

Servidores web comuns

Melhores práticas

• Defina tanto o caminho da Subpasta quanto o caminho da API do Site juntos; A hospedagem de subpastas não funciona corretamente se só uma estiver configurada.
• Use um caminho diferente do /api caminho da API do seu site se seu domínio já atende outra aplicação em /api, e mantenha as configurações do portal e do servidor sincronizadas.
• Ative o Restringir o acesso a subdomínios somente depois que seu domínio canônico estiver totalmente configurado, para evitar problemas de redirecionamento.
• Teste a configuração da sua subpasta em um caminho de staging antes de aplicá-la ao seu domínio de produção.

FAQ