Hospedando o Document360 em uma subpasta

O que é hospedagem de subpastas?

Hospedagem de subpastas é o método de organizar e exibir conteúdo em um site usando pastas sob o domínio principal (raiz). Uma subpasta (também chamada de subdiretório) aparece após o domínio raiz em uma URL e é usada para estruturar o conteúdo logicamente.
Por exemplo, o domínio raiz do Document360 é document360.com. Então, uma subpasta/subdiretório pode ser document360.com/docs/.

A maioria das empresas hospeda sua documentação em uma subpasta/subdiretório no domínio do site.
Por exemplo: example.com/docs, example.com/support, etc.

Isso porque hospedar uma base de conhecimento em um subdiretório/subpasta de um site (example.com/docs) em vez de um subdomínio (docs.example.com) é melhor para Otimização para Mecanismos de Busca (SEO).

NOTA

A hospedagem de subpastas/subdiretórios pode ser ativada para domínios fornecidos pelo Document360 e domínios personalizados mapeados.

Ativando a hospedagem de subpastas

Para habilitar a subpasta que hospeda seu projeto,

1. Navegue até Configurações () > Site da base de conhecimento na barra de navegação da esquerda no Portal da base de conhecimento.

2. No painel de navegação esquerdo, navegue até a aba Domínio personalizado Hospedagem de subpastas

   Por padrão, o caminho da Subpasta está definido como /docs.

3. Ative a opção ao lado de "A base de conhecimento está hospedada como uma subpasta."
   Quando a opção de alternância é ativada, a prévia pública dos artigos fica visível. Isso também impede a inserção do slug do espaço de trabalho ao inserir links em artigos.

Caminhos de Subpastas Personalizadas

Você também pode configurar sua base de conhecimento em caminhos de subpasta/subdiretório diferentes /docsde .

Por exemplo, /help, /support, etc.

1. Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do Portal da base de conhecimento.

2. No painel de navegação à esquerda, navegue até a aba Domínio personalizado personalizado > Hospedagem de subpastas .

   Por padrão, o caminho da Subpasta está definido como /docs.

3. Limpe o campo de caminho da Subpasta e insira o caminho da sua subpasta personalizada (por exemplo, /help).

4. Clique no Atualização  à direita.

   Essa nova subpasta personalizada só funcionará se a configuração de hospedagem da subpasta estiver ativada no seu projeto.

Ao configurar outros caminhos, adicione as linguagens associadas a cada workspace no seu projeto. Essa configuração varia dependendo dos diferentes servidores web.

NOTA

Para projetos configurados com hospedagem personalizada de domínio e subpasta, a opção de pré-visualização do artigo ainda não é suportada.

Se você definiu um caminho de subpasta personalizado, não esqueça de configurar seu servidor para fazer proxy requests para esse caminho. Você pode consultar os artigos específicos de servidores da plataforma para orientação.

Caminhos de API de Site Personalizados

Para sua informação (para informação)

O recurso de caminhos de API para sites personalizados está disponível apenas em projetos do site 2.0 da KB. Para migrar do site KB 1.0 para o site KB 2.0, leia o artigo sobre migração do site KB 2.0.

Por padrão, o caminho da API do Site é definido como /api. Você também pode personalizar o caminho da API do site a partir da aba de hospedagem de Subpastas , nas configurações de domínio personalizado.

Por exemplo, /docs-api, /api-docs, etc.

Após definir o caminho da API do Site, você também deve configurar um bloco de localização correspondente no seu servidor web (como /api, /docs-api, etc.).

Certifique-se de que o valor inserido aqui corresponda exatamente ao caminho configurado na configuração do proxy reverso do seu servidor.

Consulte o guia relevante do servidor para exemplos de configuração:

• Servidor Nginx – Hospedagem de subpastas

• ASP.NET Servidor central

• Microsoft – servidor IIS

• Servidor HTTP Apache

ATENÇÃO

Para projetos KB Site 2.0 , a hospedagem de subpastas funcionará apenas quando tanto o caminho da Subpasta quanto o caminho da API do Site estiverem definidos.

1. Navegue até Configurações () > Site da base de conhecimento na barra de navegação da esquerda no Portal da base de conhecimento.

2. No painel de navegação à esquerda, navegue até a aba Domínio personalizado Hospedagem de subpastas

   Por padrão, o caminho da API do Site está definido como /api.

3. Limpe o campo de caminho da API do site e insira o caminho da API do site personalizado (por exemplo, /docs-api).

4. Clique no Atualização  à direita.

   Esse novo caminho personalizado da API do site só funcionará se a configuração de hospedagem de subpastas estiver ativada no seu projeto.

NOTA

O caminho da API do Site Personalizado não é o caminho para a Documentação da API.

Servidores web

Aqui estão alguns dos servidores web mais usados

• Servidor HTTP Apache

• Servidor Nginx

• ASP.NET Servidor central

• Microsoft - servidor IIS

• Servidor OpenResty

• Servidor LiteSpeed

• Servidor Cloudflare

NOTA

O que é um servidor web?
Um servidor web armazena e entrega o conteúdo de um site – como texto, imagens, vídeos e dados de aplicativos – para clientes que o solicitam. O tipo mais comum de cliente é um programa de navegador web.

Configuração obrigatória de caminhos de API para o site KB 2.0

Se você está usando o KB 2.0 e hospedando sua base de conhecimento em uma subpasta, é obrigatório adicionar uma configuração de proxy reverso para o caminho da API do seu site (por exemplo, /api) nas configurações do seu servidor.

Sem essa configuração, você pode encontrar erros de redirecionamento ou comportamento de API falhado.

Visite o artigo relevante sobre o servidor para instruções de configuração:

• Servidor Nginx – Hospedagem de subpastas

• ASP.NET Servidor central

• Microsoft – servidor IIS

• Servidor HTTP Apache

O que acontece depois?

Uma vez que o servidor web seja configurado com sucesso, seu site da base de conhecimento estará ativo na sua subpasta/subdiretório personalizado. No entanto, a URL existente do seu projeto atende as solicitações.
Por exemplo, example.document360.io e example.com/docs (se /docs for o caminho da sua pasta) apontará para o site da Knowledge Base.

Isso causará conteúdo duplicado nos mecanismos de busca (Google, Bing, etc.). Para isso, você precisará habilitar um redirecionamento de URL.

NOTA

Para permitir o redirecionamento de example.document360.io para example.com/docs, por favor, entre em contato conosco pelo support@document360.com.

Solução de problemas

A URL ainda mostra '/docs' apesar da hospedagem de subpastas estar desativada

Por padrão, a documentação é hospedada na /docs subpasta, e esse caminho permanece visível na URL independentemente de a configuração de hospedagem da subpasta estar ativada ou desativada.

Passos para resolver:

Para mudar o caminho,

1. Crie uma nova subpasta no seu projeto.

2. Ative a configuração de hospedagem da subpasta para a subpasta recém-criada.

3. Complete a configuração necessária para aplicar o caminho da URL personalizada.

erro 404 devido à duplicação de '/docs' na URL canônica

Quando seu site está hospedado em uma /docs subpasta, adicionar /docs a URL canônica faz com que ela apareça duas vezes na URL final (por exemplo, nome do artigo/docs/docs/), levando a um erro 404.

Passos para resolver:

1. Para resolver o problema, atualize a URL canônica para incluir apenas o domínio sem o /docs caminho. Por exemplo, defina a URL canônica como: https://yourdomain.com/article-name

2. Isso garante que a /docs subpasta seja adicionada apenas uma vez, mantendo a estrutura correta de URL e prevenindo erros 404.