Hosten von Document360 in einem Unterordner

Was ist Subordner-Hosting?

Subordner-Hosting ist die Methode, Inhalte auf einer Website mithilfe von Ordnern unter der Haupt- (Root-)Domain zu organisieren und anzuzeigen. Ein Unterordner (auch Unterverzeichnis genannt) erscheint nach der Root-Domain in einer URL und wird verwendet, um Inhalte logisch zu strukturieren.
Zum Beispiel ist die Root-Domain von Document360 . document360.com Die URL des Unterordners/Unterverzeichnispfads könnte also lauten document360.com/docs/.

Die meisten Unternehmen hosten ihre Dokumentation unter einem Unterordner oder Unterverzeichnis auf ihrer Website-Domain.
Zum Beispiel: example.com/docs, example.com/support, usw.

Das liegt daran, dass das Hosten einer Wissensdatenbank in einem Unterverzeichnis/Unterordner einer Website (example.com/docs) statt einer Subdomain (docs.example.com) für die Suchmaschinenoptimierung (SEO) besser ist.

HINWEIS

Unterordner-/Unterverzeichnis-Hosting kann für von Document360 bereitgestellte Domains und abgebildete benutzerdefinierte Domains aktiviert werden.

Aktivierung des Unterordner-Hosting

Um das Unterordner-Hosting für Ihr Projekt zu aktivieren,

1. Navigieren Sie in der linken Navigationsleiste im Knowledge base portal zu () > Knowledge base site.

2. Im linken Navigationsbereich navigieren Sie zum Custom domain > Subfolder hosting .

   Standardmäßig ist der Unterordnerpfad auf /docs gesetzt.

3. Schalte den Schalter neben "Knowledge base is hosted as a Subfolder" ein.
   Wenn der Schalter aktiviert ist, ist die öffentliche Vorschau der Artikel sichtbar. Dies verhindert außerdem das Einfügen des Workspace-Slugs beim Einfügen von Links in Artikel.

Benutzerdefinierte Unterordnerpfade

Du kannst deine Wissensdatenbank auch auf Unterordner-/Unterverzeichnispfaden ausrichten, die /docsnicht .

Zum Beispiel /help, /support, , usw.

1. Navigieren Sie zu () > Knowledge base site in der linken Navigationsleiste im Knowledge base portal.

2. Im linken Navigationsfenster navigieren Sie zum Custom domain > Subfolder hosting .

   Standardmäßig ist der Unterordnerpfad auf /docs gesetzt.

3. Lösche das Feld für Unterordnerpfad und gib deinen benutzerdefinierten Unterordnerpfad ein (zum Beispiel, /help).

4. Klicken Sie rechts auf den Update .

   Dieser neue benutzerdefinierte Unterordner funktioniert nur, wenn die Unterordner-Hosting-Einstellung in deinem Projekt aktiviert ist.

Wenn du andere Pfade einrichtest, füge die Sprachen hinzu, die jedem Arbeitsbereich in deinem Projekt zugeordnet sind. Diese Konfiguration variiert je nach verschiedenen Webservern.

HINWEIS

Für Projekte, die mit benutzerdefiniertem Domain- und Unterordner-Hosting konfiguriert sind, wird die Artikel-Vorschauoption noch nicht unterstützt.

Wenn du einen benutzerdefinierten Unterordnerpfad definiert hast, vergiss nicht, deinen Server so zu konfigurieren, dass er Anfragen für diesen Pfad proxyt. Für Hinweise können Sie sich in den plattformspezifischen Serverartikeln orientieren.

Benutzerdefinierte Site-API-Pfade

Zu Ihrer Information (zur Info)

Die Funktion Pfade der benutzerdefinierten Site API ist nur in KB-Standort-2.0-Projekten verfügbar. Um von KB Site 1.0 zu KB Site 2.0 zu migrieren, lesen Sie den Artikel über KB Site 2.0 Migration.

Standardmäßig ist der Site-API-Pfad auf /apigesetzt. Du kannst den Site-API-Pfad auch über den Reiter Subordner Hosting in den benutzerdefinierten Domain-Einstellungen anpassen.

Zum Beispiel /docs-api, /api-docs, , usw.

Nach der Einstellung des Site-API-Pfads müssen Sie außerdem einen passenden Standortblock auf Ihrem Webserver konfigurieren (wie /api, /docs-api, usw.).

Stellen Sie sicher, dass der hier eingegebene Wert genau mit dem im Reverse-Proxy-Setup Ihres Servers konfigurierten Pfad übereinstimmt.

Siehe den entsprechenden Serverleitfaden für Konfigurationsbeispiele:

• Nginx-Server – Unterordner-Hosting

• ASP.NET Core-Server

• Microsoft – IIS-Server

• Apache HTTP Server

VORSICHT

Für KB Site-2.0-Projekte funktioniert Subordner-Hosting nur, wenn sowohl der Unterordnerpfad als auch der Site-API-Pfad definiert sind.

1. Navigieren Sie zu () > Knowledge base site in der linken Navigationsleiste im Knowledge base portal.

2. Im linken Navigationsfenster navigieren Sie zum Custom domain > Subfolder hosting .

   Standardmäßig ist der Site-API-Pfad auf /api gesetzt.

3. Lösche das Feld Site-API-Pfad und gib deinen benutzerdefinierten Site-API-Pfad ein (zum Beispiel, /docs-api).

4. Klicken Sie rechts auf den Update .

   Dieser neue benutzerdefinierte API-Pfad funktioniert nur, wenn die Unterordner-Hosting-Einstellung in deinem Projekt aktiviert ist.

HINWEIS

Der Pfad der benutzerdefinierten Site API ist nicht der Pfad für API-Dokumentation.

Webserver

Hier sind einige der am häufigsten verwendeten Webserver

• Apache HTTP Server

• Nginx-Server

• ASP.NET Core-Server

• Microsoft - IIS-Server

• OpenResty-Server

• LiteSpeed-Server

• Cloudflare-Server

HINWEIS

Was ist ein Webserver?
Ein Webserver speichert und liefert die Inhalte einer Website – wie Text, Bilder, Videos und Anwendungsdaten – an Kunden, die sie anfordern. Der häufigste Client-Typ ist ein Webbrowser-Programm.

Obligatorische API-Pfad-Einrichtung für KB-Standort 2.0

Wenn Sie KB 2.0 verwenden und Ihre Wissensdatenbank in einem Unterordner hosten, ist es zwingend erforderlich, eine Reverse-Proxy-Konfiguration für den Pfad Ihrer Site-API (zum Beispiel ) /apiin Ihren Servereinstellungen hinzuzufügen.

Ohne diese Konfiguration können Sie auf Weiterleitungsfehler oder fehlerhaftes API-Verhalten stoßen.

Siehe den entsprechenden Server-Artikel für Einrichtungsanweisungen:

• Nginx-Server – Unterordner-Hosting

• ASP.NET Core-Server

• Microsoft – IIS-Server

• Apache HTTP Server

Was passiert als Nächstes?

Sobald der Webserver erfolgreich konfiguriert ist, ist deine Wissensdatenbank in deinem eigenen Unterordner/Unterverzeichnis verfügbar. Die bestehende URL Ihres Projekts liefert jedoch die Anfragen.
Zum Beispiel example.document360.io zeigt and example.com/docs (falls /docs dein Ordnerpfad ist) auf die Knowledge Base-Seite.

Dies führt zu doppelten Inhalten in Suchmaschinen (Google, Bing usw.). Dazu müssen Sie eine URL-Weiterleitung aktivieren.

HINWEIS

Um die Weiterleitung von example.document360.io nach example.com/docszu aktivieren, kontaktieren Sie uns bitte unter support@document360.com.

Fehlerbehebung

Die URL zeigt trotz deaktivierter Unterordner-Hosting immer noch '/docs' an

Standardmäßig wird die Dokumentation unter dem /docs Unterordner gehostet, und dieser Pfad bleibt in der URL sichtbar, unabhängig davon, ob die Unterordner-Hosting-Einstellung aktiviert oder deaktiviert ist.

Schritte zur Lösung:

Um den Weg zu ändern,

1. Erstelle einen neuen Unterordner in deinem Projekt.

2. Aktiviere die Einstellung für das Hosting des Unterordners für den neu erstellten Unterordner.

3. Schließen Sie die erforderliche Konfiguration durch, um den benutzerdefinierten URL-Pfad anzuwenden.

404-Fehler aufgrund duplizierter '/docs' in der kanonischen URL

Wenn Ihre Seite in einem /docs Unterordner gehostet wird, führt das Hinzufügen /docs der kanonischen URL dazu, dass sie zweimal in der finalen URL erscheint (z. B. Artikelname/docs/docs/), was zu einem 404-Fehler führt.

Schritte zur Lösung:

1. Um das Problem zu beheben, aktualisieren Sie die kanonische URL so, dass sie nur die Domain ohne Pfad /docs enthält. Setzen Sie zum Beispiel die kanonische URL als: https://yourdomain.com/article-name

2. Dies stellt sicher, dass der /docs Unterordner nur einmal hinzugefügt wird, wodurch die korrekte URL-Struktur erhalten bleibt und 404-Fehler verhindert werden.