認証の設定

ユーザー認証でドキュメントの公開範囲を制御する

Pro プランにはパスワード認証が含まれます。

Enterprise プランにはすべての認証方法が含まれます。

認証を設定すると、ユーザーはドキュメントにアクセスする前にログインする必要があります。

認証モード

アクセス制御の要件に応じて、完全認証モードか部分的認証モードを選択します。

完全認証：すべてのページが保護対象です。ユーザーはコンテンツにアクセスする前にログインする必要があります。

部分的認証：一部のページは公開で閲覧でき、その他は認証が必要です。ユーザーは公開コンテンツを自由に閲覧でき、保護されたページにアクセスする場合にのみ認証します。

以下のいずれかのハンドシェイク方式を設定する際、ダッシュボードの設定で完全認証または部分的認証を選択します。

認証の設定

設定したいハンドシェイク方式を選択します。

Password

パスワード認証はアクセス制御のみを提供し、コンテンツのパーソナライゼーションには対応しません。

前提条件

• セキュリティ要件として、ユーザー間でパスワードを共有できること。

実装

1. パスワードを作成する

   1. ダッシュボードで Authentication に移動します。
   2. Full Authentication または Partial Authentication を選択します。
   3. Password を選択します。
   4. 安全なパスワードを入力します。
   5. Save changes を選択します。
2. アクセスを配布する

   承認済みユーザーに、パスワードとドキュメントのURLを安全に共有します。

例

ドキュメントが docs.foo.com でホストされており、個々のユーザーを追跡せずに基本的なアクセス制御が必要です。セットアップは簡単に保ちながら、一般公開は避けたい状況です。

ダッシュボードで強力なパスワードを作成し、承認済みユーザーに認証情報を共有します。以上です！

ページを公開する

部分的認証を使用している場合、すべてのページはデフォルトで保護されています。public プロパティを設定することで、ページ単位またはグループ単位で、特定のページを認証なしで閲覧可能にできます。

ページレベル

ページを公開するには、そのページのフロントマターに public: true を追加します。

Public page example

---
title: "Public page"
public: true
---

グループレベル

グループ内のすべてのページを公開するには、docs.json の navigation オブジェクトで、グループ名の直下に "public": true を追加します。

Public group example

{
  "navigation": {
    "groups": [
      {
        "group": "Public group",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "Private group",
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}