Nginx-Server

Das Hosten Ihrer Document360-Wissensdatenbank in einem Unterordner auf Nginx, wie z. example.com/docsB. , erfordert die Konfiguration von Proxy- und Rewrite-Regeln auf Ihrem Server. Dieser Artikel behandelt das Aktivieren der erforderlichen Standortblöcke, das Routing von UI- und API-Pfaden, das Erstellen von Sitemaps und die Handhabung der URL-Weiterleitung, um doppelte Inhalte in Suchmaschinen zu vermeiden.

Um mehr über Nginx selbst zu erfahren, siehe die Nginx-Dokumentation.

Bevor du anfängst

• Unterordner-Hosting funktioniert nur, wenn sowohl der Unterordnerpfad (zum Beispiel /docs oder /help) als auch der Site-API-Pfad (zum Beispiel /api oder /docs-api) in Document360 definiert sind. Nachdem Sie diese Werte gesetzt haben, konfigurieren Sie entsprechende location Blöcke in Nginx, um sowohl UI- als auch API-Verkehr zu proxyen.
• Ersetzen Sie die Beispieldomain in diesem Artikel durch Ihre eigene, von Document360 bereitgestellte oder benutzerdefinierte Domain. Zum Beispiel repräsentiert example.document360.io die Domäne und example.document360.io/docs den Pfad des Unterordners.

Wie man einen Unterordnerpfad in Nginx konfiguriert

1. Füge den folgenden Standortblock zu deiner Nginx-Konfigurationsdatei hinzu (/etc/nginx/default):

location /docs {
    proxy_pass https://example.document360.io/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;
}

2. Neustarte den Nginx-Webserver. Unter Linux verwenden Sie:

sudo systemctl restart nginx

Wie man einen benutzerdefinierten Unterordnerpfad verwendet

Du kannst deine Wissensbasis auf einem anderen Weg als /docs, wie zum Beispiel /help oder /supporthosten. Beim Einrichten eines benutzerdefinierten Pfads füge auch die jeweiligen Sprachen hinzu und starte dann den Server neu.

Das untenstehende Beispiel bildet die von Document360 bereitgestellte Domäne example.document360.io, Arbeitsbereich /v1/, Unterordnerpfad /help/und hebräischen Sprachcode /he ab – ersetze diese durch eigene Werte.

location /help {
    proxy_pass https://example.document360.io/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;

    sub_filter "v1/docs/" "v1/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}

Entfernung des Arbeitsflächen-Slugs aus internen Links

Um Workspace-Slugs aus internen Links auf Nginx-Reverse-Proxy-Ebene zu entfernen, verwenden Sie eine sub_filter Regel:

sub_filter "/Version_slug/docs/" "/help/";

Dies schreibt arbeitsraumspezifische Pfade um, bevor sie den Lesern präsentiert werden. Verwenden Sie diesen Ansatz nur, wenn Ihre Website-Struktur workspace-agnostische URLs benötigt.

Warum proxy_set_header Accept-Encoding "" ist erforderlich

Beim Hosting in einem benutzerdefinierten Unterordner verwendet sub_filter Nginx häufig die Umschreibung interner URLs wie /docs . /help Standardmäßig kann der Upstream-Server (Document360) gzip-komprimierten HTML zurückgeben, und Nginx kann keine Regeln auf komprimierte Antworten anwenden sub_filter . Dadurch bleiben interne Links ungeschrieben, Startseiten-Widgets zeigen ständig auf /docs, und Kategorienkarten oder Navigationsrouten brechen.

Um das zu beheben, deaktivieren Sie die Kompression vom Upstream-Server:

proxy_set_header Accept-Encoding "";

Dies zwingt Document360, unkomprimiertes HTML zurückzugeben, erlaubt sub_filter die korrekte Ausführung von Regeln und stellt sicher, dass Pfade wie in /docs/en/ umgeschrieben /help/en/werden. Diese Einstellung ist immer dann erforderlich, wenn sub_filter sie verwendet wird.

Wie man den Site-API-Pfad konfiguriert

Wenn Sie Ihre Wissensdatenbank in einem Unterordner hosten, müssen Sie außerdem einen Site-API-Pfad definieren und einen entsprechenden location Block in Nginx hinzufügen, um sicherzustellen, dass API-Anfragen korrekt routen und Umleitungsschleifen oder defekte API-Aufrufe verhindert werden.

Das folgende Beispiel verwendet /api als Site-API-Pfad:

location /api {
    proxy_pass https://example.document360.io/api;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name on;
    proxy_set_header Accept-Encoding "";

    sub_filter_types *;
    sub_filter "v1/docs/" "v1/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}

Sobald du beide Standortblöcke hinzugefügt hast, starte Nginx neu:

sudo systemctl restart nginx

Verwenden sub_filter_types *; Sie nur beim Umschreiben von HTML- oder API-Antworten, die möglicherweise nicht-HTML-Inhalte zurückgeben – vermeiden Sie es, es sei denn, eine URL-Umschreibung ist tatsächlich erforderlich.

Wann sollte sub_filter im API-Standortblock verwendet werden

Das Hinzufügen sub_filter von Regeln zum API-Standortblock ist nicht immer notwendig. Verwenden Sie es nur, wenn Ihr UI-Pfad umgeschrieben wird (zum Beispiel /docs → /help) oder wenn API-Antworten eingebettete /docs Pfade enthalten, die neu geschrieben werden müssen. Wenn dein Projekt weiterhin als UI-Pfad verwendet /docs wird, füge keine Regeln zum API-Block hinzu sub_filter .

Wie man das Dropdown-Menü für Arbeitsbereiche aktiviert

Um die Navigation im Workspace-Dropdown-Menü beim Hosten in einem benutzerdefinierten Unterverzeichnis zu aktivieren, fügen Sie für jeden Workspace in Ihrem Projekt einen Codeblock hinzu.

Das folgende Beispiel umfasst zwei Arbeitsbereiche, v1 und v2, mit der Domaine Document360 example.document360.io, dem Unterordnerpfad /help/und der hebräischen Sprache /he – ersetzen Sie diese durch Ihre eigenen Werte.

location /v2/help {
    proxy_pass https://example.document360.io/v2/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;

    sub_filter "v2/docs/" "v2/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}

location /v1/help {
    proxy_pass https://example.document360.io/v1/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;

    sub_filter "v1/docs/" "v1/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}

location = /v2/docs {
    return 301 /v2/help;
}

location = /v1/docs {
    return 301 /v1/help;
}

Nginx neu starten, sobald es konfiguriert ist:

sudo systemctl restart nginx

Die Standard-Startseite einer Wissensdatenbank erscheint zum Beispiel example.document360.ioim Root-Verzeichnis. Wenn Ihr Projekt eine arbeits- und sprachspezifische Startseite hat, folgt der Slug nach dem Root-Verzeichnis zum Beispiel example.document360.io/v2/hedem Format/<workspace_name>/<language_code>.

Wie man die Sitemap-Erstellung einrichtet

Das Sitemap-Präfix bleibt gleich, außer dem Sprachcode (en, fr, de usw.).

location /sitemap.xml.en {
    proxy_pass https://example.document360.io/sitemap.xml.en;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;
    proxy_set_header Accept-Encoding "";

    sub_filter_types text/xml;
    sub_filter "https://www.example.document360.io/docs/" "https://www.example.document360.io/help/";
    sub_filter_once off;
 }

Wie man die kanonische URL einlegt

Wenn Sie Ihre Wissensdatenbank in einem Unterordner hosten, konfigurieren Sie eine kanonische URL, sodass Suchmaschinen Ihre benutzerdefinierte Domain und den Unterordnerpfad anstelle der Standarddomäne *.document360.io indexieren. Dies verhindert doppelte Indexierung und verbessert die SEO-Leistung.

1. Navigieren Sie zu > Knowledge base site > Custom domain > Subfolder hosting.
2. Geben Sie zum Beispiel https://example.com/helpdie URL des vollständigen Unterordners ein.
3. Klicken Sie auf Speichern.

Nach der Konfiguration behandeln Suchmaschinen die Unterordner-URL als primäre Quelle für die Indexierung.

Was passiert als Nächstes

Sobald Nginx konfiguriert ist, ist deine Wissensdatenbank in deinem benutzerdefinierten Unterordner verfügbar. Die bestehende Document360-URL bedient weiterhin Anfragen – zum Beispiel verweisen sowohl example.document360.io und example.com/docs auf die Website Ihrer Wissensdatenbank. Dies führt zu doppelten Inhalten in Suchmaschinen.

Um dies zu verhindern, aktivieren Sie unter () > Knowledge base site > Custom domain > Subfolder hosting" (Subdomain-Zugriff). Stelle sicher, dass zuerst eine kanonische Domain konfiguriert ist – sobald sie aktiviert ist, leitet deine Document360-Subdomain automatisch auf deine kanonische Domain um.

Hilfreiche Links

• NGINX Docs: NGINX und NGINX Plus als Webserver konfigurieren
• DigitalOcean: Verständnis von Nginx-Server- und Standortblockauswahlalgorithmen

Best Practices

• Füge immer zu jedem Standortblock sub_filtermit proxy_set_header Accept-Encoding ""; , sonst gelten deine Umschreibregeln nicht für komprimierte Antworten.
• Halte den Site-API-Pfad zwischen dem Document360-Portal und deiner Nginx-Konfiguration identisch – eine Diskrepanz führt zu fehlerhaften API-Aufrufen.
• Füge Regeln zum API-Standortblock nur dann hinzu, sub_filter wenn dein UI-Pfad neu geschrieben wird oder API-Antworten eingebettete /docs Pfade enthalten.
• Konfigurieren Sie eine kanonische URL, bevor Sie den Zugriff auf Subdomain einschränken aktivieren, um Umleitungsprobleme während der Einrichtung zu vermeiden.

FAQ