Docsbook
概要

カスタムドメインを設定する

カスタムドメインを使用すると、所有しているアドレス(docs.example.com)からDocsbookのドキュメントを提供できます(docsbook.io/user/repoではありません)。DNSが解決されると、DocsbookがSSL証明書を自動的に発行します。

サイトの提供、ドメイン、およびその証明書ではAIモデルを呼び出さないため、カスタムドメインがどれだけのトラフィックを処理しても、プロジェクトの残高を消費することはありません。

なぜ自分のドメインでドキュメントを配信するのか#

  • 検索上の評価があなたのドメインに蓄積されます。人々があなたのドキュメントに張るリンクはexample.comを指すため、そのリンクがもたらす評価は、docsbook.ioではなく、検索順位を上げたいドメインに集まります。
  • 読者からは一つの会社に見えます。アドレスバーに表示されるドメインが、読者が訪れた製品のものと一致します。
  • 移行してもアドレスは変わりません。将来Docsbookを離れることになっても、docs.example.comはその後に提供するサービスに対して機能し続けますが、docsbook.io/user/repoのURLはそうなりません。

開始する前に#

必要なものは2つです:

  1. 管理しているドメイン(任意のレジストラで登録済みのもの)。
  2. そのドメインのDNS設定へのアクセス権(レコードを1つ追加できるようにするため)。

手順 1:カスタムドメイン設定を開く#

  1. サインインした状態でドキュメントを開きます。
  2. 右下のフロートウィジェットをクリックします。
  3. 設定カスタムドメインを開きます。

ステップ2:ドメインを入力#

  1. ドメインを入力します。例:docs.example.com
  2. 保存をクリックします。

Docsbookは必要なDNSレコードを生成し、すぐに表示します。各値にはコピーボタンがあります。

ステップ 3: レジストラで DNS レコードを追加する#

レコードの種類は、サブドメインを使用するか、ドメインのルートを使用するかによって異なります。

サブドメイン — 推奨。例: docs.example.comCNAME を追加します:

名前 / ホスト 種類
docs (サブドメインのみ) CNAME cname.vercel-dns.com

ルートまたはアペックスドメイン — 例: example.com。ほとんどのレジストラではルートに CNAME を設定できないため、代わりに A レコードを追加します:

名前 / ホスト 種類
@ A 216.150.1.1

このページからではなく、カスタムドメインパネルから値をコピーしてください。パネルにはあなたのドメインに対する正確なターゲットが表示されます。上記の値は通常のデフォルト値であり、異なる場合があります。

一般的なレジストラでDNS設定がある場所#

GoDaddy

  1. godaddy.com にサインインします。
  2. マイドメイン → ドメイン → DNS に移動します。
  3. 追加をクリックし、次の項目を入力します:タイプ CNAME、名前 docs、指定先 cname.vercel-dns.com
  4. 保存します。

Namecheap

  1. namecheap.com にサインインします。
  2. ドメインリスト管理高度なDNS に移動します。
  3. レコードを追加します:タイプ CNAME、ホスト docs、値 cname.vercel-dns.com、TTL 3600
  4. 保存します。

Ionos(旧称 1&1)

  1. サインインしてドメインを開きます。
  2. ドメインを選択し、DNSの管理を開きます。
  3. レコードを追加します:タイプ CNAME、サブドメイン docs、エイリアス cname.vercel-dns.com
  4. 保存します。

その他のレジストラも同じ手順です:DNSまたはネームサーバーのパネルを見つけ、Docsbookパネルに表示されているタイプのレコードを追加し、値を貼り付けます。

サブドメインではなくルートドメインを使用する場合#

可能な場合はdocs.example.comを使用してください。設定が簡単で、製品サイト用にexample.comを空けておけます。

ルートドメインが必要な場合は、上記のAレコードを使用してください — Custom Domainパネルに表示されている正確なIPをコピーし、レジストラのインターフェースにその項目がない場合はsupport@docsbook.ioまでご連絡ください。

ステップ 4:DNS の伝播を待つ#

DNS の変更が表示されるまで通常 15~30 分かかり、最大 48 時間かかる場合があります。

Custom Domain パネルで Check domain status をクリックします。次の 3 つの状態のいずれかが表示されます。

ステータス 意味 対処方法
Domain verified(緑) DNS が解決され、ドメインが稼働しています 何もする必要はありません。サイトを開きます
Waiting for DNS verification(黄) レコードがまだ表示されていません 15~60 分待ってから、もう一度確認します
Conflicting DNS record found(黄) 同じ名前の別のレコードが干渉しています 競合しているレコードを削除して、もう一度確認します

Docsbook の外部から確認するには、ルックアップを実行します。

nslookup docs.example.com

応答には cname.vercel-dns.com が示されるはずです。DNSChecker では複数の国からの同じ応答を一度に確認できるため、伝播が部分的な間に便利です。

ステップ5:SSL証明書の発行を待つ#

DNSが解決されると、Docsbookがドメインを検出し、Let's Encrypt証明書をリクエストしてHTTPSを有効にします。クリックする必要はありません。

その後、ドキュメントは次のURLで提供されます:

https://docs.example.com

トラブルシューティング#

2時間経過してもドメインが機能しない
  1. DNSCheckerでレコードを確認します — そこに表示されない場合は、レコードが間違っているか保存されていません。
  2. レコードの種類と値が、カスタムドメインパネルの内容と完全に一致していることを確認します。
  3. ローカルキャッシュを使用しないプライベートブラウザーウィンドウでサイトを開きます。
  4. 失敗と判断する前に、最大48時間待ちます。
古いサイトが表示され続ける

ブラウザーにキャッシュされています。Ctrl+F5(macOSではCmd+Shift+R)を押すか、プライベートウィンドウを開いてください。24時間以上古いバージョンが表示され続ける場合は、パネルでドメインのステータスを確認してください。

HTTPSで証明書エラーが表示される

証明書はDNSの名前解決後に発行されるため、新しいドメインではHTTPSの準備が整う前にHTTPが提供されることがあります。1時間待ち、DNSが伝播していることを確認し、ドメイン名にタイプミスがないか確認してください。解決しない場合はsupport@docsbook.ioまでご連絡ください。

ドメインにVercelのエラーページが表示される

ドメインは名前解決されていますが、まだ接続されていません。設定カスタムドメインドメインのステータスを確認をクリックし、Docsbookにドメインが保存されていることと、DNSレコードが一致していることを確認してください。双方の設定が一致するまで1〜2時間かかる場合があります。

Cloudflareのプロキシが検証を妨げる

DNSレコードをDNSのみに設定します — オレンジ色の雲ではなく、灰色の雲です。ドメインを検証できるようになる前にオレンジ色の雲がトラフィックをプロキシするため、ドメインが検証されない状態やSSLエラーとして現れます。灰色に切り替えてから、もう一度ドメインのステータスを確認をクリックしてください。

ドメインを変更または削除#

別のドメインに移行するには、SettingsCustom Domain を開き、値を置き換えて Save をクリックし、新しいドメインの DNS レコードを追加します。古いドメインではドキュメントが提供されなくなります。

Docsbook のアドレスに戻すには、Custom Domain フィールドを空にして Save をクリックします。ドキュメントは docsbook.io/username/repo に戻ります。

ドメインが有効になったら#

  • 古いアドレスを指すすべてのリンクを更新する — GitHub README、製品サイト、メール署名、ソーシャルプロフィールを更新します。古いアドレスのまま残っているリンクは、評価をdocsbook.ioに送ってしまいます。
  • 目的ごとにサブドメインを使うdocs.example.comguide.example.comapi.example.com。ルートドメインにドキュメントを置くと、メインサイトと競合します。
  • 到着するトラフィックを監視する。 ウェブ解析では、初回の訪問から新しいドメインに対する閲覧数、参照元、検索クエリを確認できます。

次のステップ#

Updated

このページは役に立ちましたか?