Serveur HTTP Apache

Héberger votre base de connaissances Document360 dans un sous-dossier sur Apache, comme example.com/docs, nécessite d’activer les modules Apache et de configurer les règles de proxy et de redirection. Cet article traite de l’activation des modules requis, du routage de la page d’accueil, des pages d’article et de catégorie, ainsi que du chemin de l’API du site, de la génération de sitemaps et de la gestion de la redirection URL pour éviter le contenu dupliqué dans les moteurs de recherche.

NOTE

Remplacez le domaine d’exemple tout au long de cet article par votre propre domaine fourni par Document360 ou un domaine personnalisé. Par exemple, example.document360.io représente votre domaine, example.document360.io/v1 représente le chemin d’un sous-dossier d’espace de travail, et example.document360.io/help représente le chemin de la page d’accueil d’un sous-dossier.

Avant que tu commences

L’hébergement de sous-dossiers ne fonctionne que lorsque le chemin des sous-dossiers (par exemple, /docs ou /help) et le chemin de l’API Site (par exemple, /api) sont définis dans Document360, avec une configuration correspondante sur votre serveur.

Assurez-vous que les modules Apache suivants sont activés — ils font partie de l’installation standard d’Apache :

proxy
proxy_http
headers
substitute
proxy_html

Facilitez-les avec :

sudo a2enmod proxy proxy_http headers substitute proxy_html

Comment configurer la page d’accueil

Configurez le bloc de localisation de l’hôte virtuel suivant pour proxy les requêtes de la page d’accueil, où le chemin commence par /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>

Correction des liens d’aperçu d’article pour l’hébergement de sous-dossiers

Les liens d’aperçu de l’article dans le portail Document360 incluent l’espace de travail et le slug de langue dans l’URL. Par exemple, l’URL de l’article en direct pourrait être docs.example.com/getting-started, tandis que le lien d’aperçu du portail est docs.example.com/v1/en/getting-started. Vous pouvez soit ajouter un bloc de localisation pour gérer le /v1/en chemin, soit définir une redirection depuis /v1/en vers /:

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

Cette redirection nécessite le rewrite module :

sudo a2enmod rewrite

Comment configurer les pages d’articles et de catégories

Ajoutez les blocs de localisation suivants au même fichier de configuration Apache Virtual Host aux requêtes proxy article, catégorie et 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>

Redémarrez le serveur Apache une fois configuré :

sudo systemctl restart apache2

NOTE

Remplacez /docs et /api par les valeurs exactes configurées dans le chemin du sous-dossier et le chemin de l’API du site dans le portail Document360.

Comment configurer la génération de sitemap

Le préfixe de la carte de site reste le même sauf pour le code de la langue (en, fr, de, etc.).

<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>

Que se passe-t-il ensuite

Une fois Apache configuré, votre site de base de connaissances est en ligne dans votre sous-dossier personnalisé. L’URL existante de Document360 continue également de répondre aux requêtes — par exemple, les deux example.document360.io et example.com/docs pointera vers votre site de base de connaissances. Cela provoque des doublons de contenu dans les moteurs de recherche comme Google et Bing.

Pour éviter le doublon, activez le bouton Restreindre l’accès au sous-domaine dans > Knowledge base site > Custom domain. Subfolder hosting Assurez-vous qu’un domaine canonique est configuré avant de l’activer — une fois activé, votre sous-domaine Document360 redirige automatiquement vers votre domaine canonique.

Meilleures pratiques

Activez les cinq modules Apache requis (proxy, proxy_http, headers, substitute, proxy_html) avant de configurer les blocs de localisation, ou alors le proxy et la réécriture ne fonctionneront pas.
Gardez le chemin du sous-dossier et le chemin de l’API du site identiques entre le portail Document360 et votre configuration Apache pour éviter des routages défectueux.
Utilisez les substitute règles de manière cohérente sur la page d’accueil, l’article/catégorie et les blocs de localisation de l’API pour éviter les liens mixtes /docs et /help les liens sur le site en ligne.
Configurez tôt la /v1/en redirection pour les liens de prévisualisation de l’article, car des liens d’aperçu incompatibles peuvent autrement causer de la confusion chez les auteurs de contenu.