Bereitstellungsübersicht
Hosting-Optionen für Ihre Dokumentation: Jamdesk-Subdomain, eigene Domain mit SSL oder ein /docs-Unterpfad hinter Ihrer bestehenden Website per Reverse-Proxy.
Jamdesk stellt Ihre Dokumentation auf einer *.jamdesk.app-Subdomain bereit. Um auf Ihrer eigenen Domain online zu gehen, wählen Sie eine eigene Subdomain (z. B. docs.example.com) oder einen Unterpfad auf Ihrer Hauptseite. Der Unterpfad ist standardmäßig /docs, oder ein beliebiger eigener Pfadabschnitt Ihrer Wahl.
Optionen für die Bereitstellung
| Option | Geeignet für | Einrichtungsaufwand |
|---|---|---|
Jamdesk-Subdomain (your-project.jamdesk.app) | Schnellster Start, keine DNS-Arbeit | Gering |
Eigene Subdomain (docs.example.com) | Produktionsdokumentation mit Ihrer Marke | Mittel |
Unterpfad-Hosting (example.com/docs, anpassbar) | Dokumentation auf der Hauptdomain belassen | Hoch |
Standardhosting (keine Einrichtung)
Jedes Projekt ist auf einer Jamdesk-Subdomain online, sobald Sie ein Repository verbinden. Nutzen Sie sie für interne Dokumentation, Vorschauen oder frühe Veröffentlichungen.
Benutzerdefinierte Domain (Subdomain)
Verwenden Sie Ihre eigene Subdomain (zum Beispiel docs.example.com) für eine markenkonforme öffentliche URL. Fügen Sie DNS-Einträge hinzu und bestätigen Sie die Inhaberschaft im Jamdesk-Dashboard.
Jamdesk prüft das DNS und stellt SSL aus, sobald die Einträge vorhanden sind. Die Einrichtung finden Sie unter Eigene Domains.
Hosting unter einem Unterpfad
Leiten Sie den Traffic an Jamdesk weiter, um die Dokumentation unter einem Unterpfad Ihrer Domain zu hosten. Standard ist example.com/docs, oder Sie wählen einen eigenen Pfadabschnitt wie example.com/help. Diese Option eignet sich, wenn Sie die Dokumentation unter Ihrer Hauptmarketing-Domain belassen möchten.
Unterpfad-Hosting erfordert eine Proxy- oder CDN-Schicht, die Anfragen weiterleitet und den Header X-Jamdesk-Forwarded-Host setzt. Siehe Unterpfad-Hosting.
Beispiel für einen Proxy-Ausschnitt (nginx)
location /docs {
proxy_pass https://YOUR_SLUG.jamdesk.app;
proxy_set_header X-Jamdesk-Forwarded-Host $host;
}
location /_next/ {
proxy_pass https://YOUR_SLUG.jamdesk.app;
}
location /_jd/ {
proxy_pass https://YOUR_SLUG.jamdesk.app;
}
Eine vollständige Konfiguration mit SSL, Headern und anbieterspezifischen Schritten finden Sie im Leitfaden Unterpfad-Hosting.
Leitfäden für Anbieter
Wählen Sie den Leitfaden für Ihre Infrastruktur: