Servidor HTTP Apache

Hospedar sua base de conhecimento Document360 em uma subpasta no Apache, como example.com/docs, requer habilitar módulos Apache e configurar regras de proxy e redirecionamento. Este artigo aborda a habilitação dos módulos necessários, o roteamento da página inicial, páginas do artigo e da categoria, e o caminho da API do Site, geração de sitemaps e gerenciamento do redirecionamento de URLs para evitar conteúdo duplicado nos mecanismos de busca.

NOTA

Substitua o domínio de exemplo ao longo deste artigo por seu próprio domínio fornecido pelo Document360 ou domínio personalizado. Por exemplo, example.document360.io representa seu domínio, example.document360.io/v1 representa o caminho de uma subpasta de workspace e example.document360.io/help representa o caminho da página inicial de uma subpasta.

Antes de começar

A hospedagem de subpastas funciona apenas quando tanto o caminho da subpasta (por exemplo, /docs ou /help) quanto o caminho da API do site (por exemplo, /api) são definidos no Document360, com configuração correspondente no seu servidor.

Certifique-se de que os seguintes módulos do Apache estejam habilitados — eles fazem parte da instalação padrão do Apache:

proxy
proxy_http
headers
substitute
proxy_html

Capacite-os com:

sudo a2enmod proxy proxy_http headers substitute proxy_html

Como configurar a página inicial

Configure o seguinte bloco de localização do Host Virtual para proxy requests para a página inicial, onde o caminho começa com /help:

<Location /help>
   ProxyPreserveHost off
   RequestHeader set Host example.document360.io
   RequestHeader set requested-by proxy
   RequestHeader unset Accept-Encoding
   ProxyPass https://example.document360.io/v1
   ProxyPassReverse https://example.document360.io/v1

   AddOutputFilterByType SUBSTITUTE text/html
   substitute 's|href="/docs|href="/help|ni'
   substitute 's|href="/v1/docs|href="/help|ni'
   substitute 's|href="https://example.document360.io/docs|href="https://docs.example.com/help|ni'
</Location>

Correção de links de pré-visualização de artigos para hospedagem de subpastas

Links de pré-visualização do artigo no portal Document360 incluem o espaço de trabalho e o slug de idioma na URL. Por exemplo, a URL do artigo em andamento pode ser docs.example.com/getting-started, enquanto o link de pré-visualização do portal é docs.example.com/v1/en/getting-started. Você pode adicionar um bloco de localização para lidar com o /v1/en caminho, ou definir um redirecionamento de /v1/en para /:

RewriteEngine on
RewriteRule ^v1/en$ / [R=301,L,NC]

Esse redirecionamento requer o rewrite módulo:

sudo a2enmod rewrite

Como configurar páginas de artigos e categorias

Adicione os seguintes blocos de localização ao mesmo arquivo de configuração do Apache Virtual Host para proxy de artigo, categoria e solicitações de API:

<Location /help/>
   ProxyPreserveHost off
   RequestHeader set Host example.document360.io
   RequestHeader set requested-by proxy
   ProxyPass https://example.document360.io/docs/
   ProxyPassReverse https://example.document360.io/docs/

   AddOutputFilterByType SUBSTITUTE text/html
   substitute 's|href="/docs|href="/help|ni'
   substitute 's|href="/v1/docs|href="/help|ni'
   substitute 's|href="https://example.document360.io/docs|href="https://docs.example.com/help|ni'
</Location>

<Location /api>
  ProxyPreserveHost off
  RequestHeader set Host example.document360.io
  RequestHeader set requested-by proxy
  RequestHeader unset Accept-Encoding
  ProxyPass https://example.document360.io/api
  ProxyPassReverse https://example.document360.io/api

  AddOutputFilterByType SUBSTITUTE application/json
  substitute 's|href="/docs/|href="/help/|ni'
  substitute 's|href="/v1/docs/|href="/help/|ni'
  substitute 's|href="https://example.document360.io/docs/|href="https://docs.example.com/help/|ni'
</Location>

Reinicie o servidor Apache assim que estiver configurado:

sudo systemctl restart apache2

NOTA

Substitua /docs e /api pelos valores exatos configurados em caminho de Subpasta e caminho da API do Site no portal Document360.

Como configurar a geração de sitemaps

O prefixo do sitemap permanece o mesmo, exceto pelo código da língua (en, fr, de, e assim por diante).

<Location /sitemap.xml.en>
    RequestHeader set Host example.document360.io
    RequestHeader set requested-by proxy
    ProxyPass https://example.document360.io/sitemap.xml.en
    ProxyPassReverse https://example.document360.io/sitemap.xml.en
</Location>

O que acontece a seguir

Depois que o Apache está configurado, seu site de base de conhecimento fica ativo na sua subpasta personalizada. A URL existente do Document360 continua atendo a solicitações também — por exemplo, tanto example.document360.io example.com/docs quanto apontam para o seu site de 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ínios 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 habilitar isso — uma vez habilitado, seu subdomínio Document360 redireciona automaticamente para seu domínio canônico.

Melhores práticas

Ative todos os cinco módulos Apache necessários (proxy, proxy_http, headers, substitute, proxy_html) antes de configurar blocos de localização, ou proxyar e reescrever não funcionará.
Mantenha o caminho da Subpasta e o caminho da API do Site idênticos entre o portal Document360 e sua configuração do Apache para evitar roteamento quebrado.
Use as substitute regras de forma consistente na página inicial, artigo/categoria e blocos de localização da API para evitar misturas /docs e /help links no site ativo.
Configure o /v1/en redirecionamento para links de prévia de artigo cedo, pois links de prévia incompatíveis podem causar confusão para os autores de conteúdo.