Docsbook
Übersicht

Eine benutzerdefinierte Domain einrichten

Eine benutzerdefinierte Domain stellt Ihre Docsbook-Dokumentation unter einer Adresse bereit, die Ihnen gehört — docs.example.com statt docsbook.io/user/repo. Docsbook stellt das SSL-Zertifikat automatisch aus, sobald die DNS-Auflösung funktioniert.

Für die Bereitstellung der Website sowie der Domain und ihres Zertifikats wird kein KI-Modell verwendet. Eine benutzerdefinierte Domain belastet daher unabhängig vom übertragenen Datenverkehr das Guthaben des Projekts nicht.

Warum Dokumentation über Ihre eigene Domain bereitstellen#

  • Die Suchautorität wird Ihrer Domain zugeschrieben. Links, die Nutzer zu Ihrer Dokumentation erstellen, verweisen auf example.com, sodass die Autorität dieser Links auf der Domain landet, für die Sie ein besseres Ranking erzielen möchten, und nicht auf docsbook.io.
  • Leser sehen ein einheitliches Unternehmen. Die Adressleiste entspricht dem Produkt, von dem sie gekommen sind.
  • Die Adresse bleibt bei einem Wechsel erhalten. Falls Sie Docsbook jemals verlassen, funktioniert docs.example.com weiterhin mit dem Dienst, der die Adresse dann bereitstellt; eine docsbook.io/user/repo-URL tut dies nicht.

Bevor Sie beginnen#

Sie benötigen zwei Dinge:

  1. Eine Domain, über die Sie verfügen, die bei einem beliebigen Registrar registriert ist.
  2. Zugriff auf die DNS-Einstellungen dieser Domain, damit Sie einen Eintrag hinzufügen können.

Schritt 1: Einstellung für benutzerdefinierte Domain öffnen#

  1. Öffne deine Dokumentation, während du angemeldet bist.
  2. Klicke unten rechts auf das Float Widget.
  3. Öffne Einstellungen → Benutzerdefinierte Domain.

Schritt 2: Geben Sie Ihre Domain ein#

  1. Geben Sie Ihre Domain ein, zum Beispiel docs.example.com.
  2. Klicken Sie auf Speichern.

Docsbook generiert den benötigten DNS-Eintrag und zeigt ihn sofort an, mit einer Schaltfläche Kopieren für jeden Wert.

Schritt 3: DNS-Eintrag bei Ihrem Registrar hinzufügen#

Der Eintragstyp hängt davon ab, ob Sie eine Subdomain oder die Domainwurzel verwenden.

Subdomain — empfohlen, z. B. docs.example.com. Fügen Sie einen CNAME-Eintrag hinzu:

Name / Host Typ Wert
docs (nur die Subdomain) CNAME cname.vercel-dns.com

Root- oder Apex-Domain — z. B. example.com. Die meisten Registrare lehnen einen CNAME-Eintrag für die Domainwurzel ab. Fügen Sie stattdessen einen A-Eintrag hinzu:

Name / Host Typ Wert
@ A 216.150.1.1

Kopieren Sie die Werte aus dem Bereich Benutzerdefinierte Domain und nicht von dieser Seite. Der Bereich zeigt das genaue Ziel für Ihre Domain an; die oben aufgeführten Werte sind die üblichen Standardwerte und können abweichen.

Wo sich die DNS-Einstellungen bei gängigen Registraren befinden#

GoDaddy

  1. Melden Sie sich bei godaddy.com an.
  2. Gehen Sie zu Meine Domains → Ihrer Domain → DNS.
  3. Klicken Sie auf Hinzufügen und geben Sie Folgendes ein: Typ CNAME, Name docs, Verweist auf cname.vercel-dns.com.
  4. Speichern Sie.

Namecheap

  1. Melden Sie sich bei namecheap.com an.
  2. Gehen Sie zu Domainliste → Verwalten → Erweiterte DNS.
  3. Fügen Sie einen Eintrag hinzu: Typ CNAME, Host docs, Wert cname.vercel-dns.com, TTL 3600.
  4. Speichern Sie.

Ionos (ehemals 1&1)

  1. Melden Sie sich an und öffnen Sie Domains.
  2. Wählen Sie Ihre Domain aus und öffnen Sie DNS verwalten.
  3. Fügen Sie einen Eintrag hinzu: Typ CNAME, Subdomain docs, Alias cname.vercel-dns.com.
  4. Speichern Sie.

Jeder andere Registrar funktioniert auf die gleiche Weise: Suchen Sie das DNS- oder Nameserver-Panel, fügen Sie einen Eintrag des im Docsbook-Panel angezeigten Typs hinzu und fügen Sie den Wert ein.

Wenn Sie statt einer Subdomain die Root-Domain verwenden möchten#

Verwenden Sie docs.example.com, wo möglich. Dies ist einfacher zu konfigurieren und lässt example.com für Ihre Produktseite frei.

Wenn Sie die Root-Domain benötigen, verwenden Sie den oben genannten A-Eintrag – kopieren Sie die im Bereich „Benutzerdefinierte Domain“ angezeigte IP-Adresse exakt – und schreiben Sie an support@docsbook.io, wenn die Benutzeroberfläche Ihres Registrars keinen solchen Eintrag anbietet.

Schritt 4: Warten, bis DNS propagiert ist#

DNS-Änderungen werden normalerweise innerhalb von 15–30 Minuten sichtbar, können aber bis zu 48 Stunden dauern.

Klicken Sie im Bereich Benutzerdefinierte Domain auf Domainstatus prüfen. Es wird einer von drei Status angezeigt:

Status Bedeutung Maßnahme
Domain verifiziert (grün) DNS wird aufgelöst und die Domain ist live Nichts; öffnen Sie die Website
Warten auf DNS-Verifizierung (gelb) Der Eintrag ist noch nicht sichtbar Warten Sie 15–60 Minuten und prüfen Sie erneut
Widersprüchlicher DNS-Eintrag gefunden (gelb) Ein anderer Eintrag mit demselben Namen verursacht eine Störung Entfernen Sie den widersprüchlichen Eintrag und prüfen Sie erneut

Um die Prüfung außerhalb von Docsbook zu bestätigen, führen Sie eine Abfrage durch:

nslookup docs.example.com

Die Antwort sollte cname.vercel-dns.com nennen. DNSChecker zeigt dieselbe Antwort gleichzeitig aus mehreren Ländern an, was nützlich ist, solange die Propagierung noch nicht vollständig ist.

Schritt 5: SSL-Zertifikat ausstellen lassen#

Sobald DNS aufgelöst wird, erkennt Docsbook die Domain, beantragt ein Let's-Encrypt-Zertifikat und aktiviert HTTPS. Sie müssen nichts anklicken.

Ihre Dokumentation wird dann unter folgender Adresse bereitgestellt:

https://docs.example.com

Fehlerbehebung#

Die Domain funktioniert auch nach zwei Stunden noch nicht
  1. Überprüfen Sie den Eintrag in DNSChecker – wenn er dort nicht sichtbar ist, ist der Eintrag falsch oder wurde nicht gespeichert.
  2. Bestätigen Sie, dass Typ und Wert des Eintrags genau mit dem Bereich „Benutzerdefinierte Domain“ übereinstimmen.
  3. Öffnen Sie die Website in einem privaten Browserfenster, das Ihren lokalen Cache umgeht.
  4. Warten Sie bis zu 48 Stunden, bevor Sie von einem Fehler ausgehen.
Die alte Website wird weiterhin angezeigt

Ihr Browser hat sie im Cache gespeichert. Drücken Sie Strg+F5 (Cmd+Shift+R unter macOS) oder öffnen Sie ein privates Fenster. Wenn die alte Version länger als 24 Stunden bestehen bleibt, überprüfen Sie den Domainstatus im Bereich.

HTTPS zeigt einen Zertifikatsfehler an

Das Zertifikat wird ausgestellt, nachdem DNS aufgelöst wurde. Daher kann eine neue Domain HTTP bereitstellen, bevor HTTPS verfügbar ist. Warten Sie eine Stunde, bestätigen Sie, dass DNS propagiert wurde, und überprüfen Sie den Domainnamen auf Tippfehler. Wenn das Problem weiterhin besteht, schreiben Sie an support@docsbook.io.

Die Domain zeigt eine Vercel-Fehlerseite an

Die Domain wird aufgelöst, ist aber noch nicht zugewiesen. Klicken Sie unter Einstellungen → Benutzerdefinierte Domain auf Domainstatus prüfen, bestätigen Sie, dass die Domain in Docsbook gespeichert ist, und überprüfen Sie, dass der DNS-Eintrag übereinstimmt. Warten Sie ein bis zwei Stunden, bis beide Seiten übereinstimmen.

Die Proxy-Funktion von Cloudflare blockiert die Verifizierung

Setzen Sie den DNS-Eintrag auf Nur DNS – die graue Wolke, nicht die orangefarbene. Die orangefarbene Wolke leitet den Datenverkehr weiter, bevor die Domain verifiziert werden kann. Dies zeigt sich daran, dass eine Domain nie verifiziert wird oder SSL-Fehler auftreten. Wechseln Sie zur grauen Wolke und klicken Sie dann erneut auf Domainstatus prüfen.

Domain ändern oder entfernen#

Um zu einer anderen Domain zu wechseln: Öffnen Sie Einstellungen → Benutzerdefinierte Domain, ersetzen Sie den Wert, klicken Sie auf Speichern und fügen Sie den DNS-Eintrag für die neue Domain hinzu. Die alte Domain stellt Ihre Dokumentation nicht mehr bereit.

Um zur Docsbook-Adresse zurückzukehren: Leeren Sie das Feld Benutzerdefinierte Domain und klicken Sie auf Speichern. Ihre Dokumentation ist wieder unter docsbook.io/username/repo verfügbar.

Nachdem die Domain live ist#

  • Aktualisiere jeden Link, der auf die alte Adresse verweist — dein GitHub-README, deine Produktseite, deine E-Mail-Signatur und deine Social-Media-Profile. Links, die auf der alten Adresse verbleiben, leiten Autorität an docsbook.io weiter.
  • Bevorzuge eine Subdomain pro Zweck — docs.example.com, guide.example.com, api.example.com. Wenn du die Dokumentation auf der Root-Domain ablegst, konkurriert sie mit deiner Hauptwebsite.
  • Beobachte den eingehenden Traffic. Webanalyse erfasst Aufrufe, Referrer und Suchanfragen für die neue Domain ab dem ersten Besuch.

Nächste Schritte#

Updated

War diese Seite hilfreich?

Powered by Docsbook