Übersicht zur Bereitstellung
Hosting-Optionen für deine Dokumentation: Jamdesk-Subdomain, eigene Domain mit SSL oder ein /docs-Unterpfad hinter deiner bestehenden Website per Reverse Proxy.
Jamdesk stellt deine Dokumentation automatisch unter einer *.jamdesk.app-Subdomain bereit. Wenn du bereit bist, deine eigene Domain zu verwenden, kannst du eine benutzerdefinierte Subdomain wie docs.example.com wählen oder deine Dokumentation unter einem Unterpfad deiner Hauptwebsite hosten: standardmäßig unter /docs oder unter einem benutzerdefinierten Segment deiner Wahl.
Optionen für die Bereitstellung
| Option | Geeignet für | Komplexität der Einrichtung |
|---|---|---|
Jamdesk-Subdomain (your-project.jamdesk.app) | Schnellster Start ohne DNS-Aufwand | Niedrig |
Benutzerdefinierte Subdomain (docs.example.com) | Produktionsdokumentation mit deiner Marke | Mittel |
Hosting unter einem Unterpfad (example.com/docs, anpassbar) | Dokumentation auf der Hauptdomain | Hoch |
Standardhosting (keine Einrichtung)
Jedes Projekt wird live unter einer Jamdesk-Subdomain bereitgestellt, sobald du ein Repository verbindest. Dies ist die einfachste Option für interne Dokumentation, Vorschauen oder frühe Starts.
Benutzerdefinierte Domain (Subdomain)
Verwende deine eigene Subdomain, zum Beispiel docs.example.com, für eine markengerechte, öffentlich zugängliche URL. Du fügst DNS-Einträge hinzu und bestätigst den Besitz im Jamdesk-Dashboard.
Die DNS-Bestätigung und SSL werden automatisch durchgeführt, sobald die Einträge vorhanden sind. Weitere Informationen zur Einrichtung findest du unter Benutzerdefinierte Domains.
Hosting unter einem Unterpfad
Hoste deine Dokumentation unter einem Unterpfad deiner Domain, indem du den Datenverkehr per Proxy an Jamdesk weiterleitest: standardmäßig unter example.com/docs oder unter einem benutzerdefinierten Segment wie example.com/help. Verwende diese Option, wenn deine Dokumentation unter deiner zentralen Marketingdomain verfügbar sein soll.
Für das Hosting unter einem Unterpfad ist eine Proxy- oder CDN-Ebene erforderlich, die Anfragen weiterleitet und den Header X-Jamdesk-Forwarded-Host setzt. Siehe Hosting unter einem Unterpfad.
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 Hinweisen findest du im Leitfaden Hosting unter einem Unterpfad.
Leitfäden für Anbieter
Wähle deine Infrastruktur, um das Hosting unter einem Unterpfad zu implementieren: