Pro-Pläne enthalten Passwortauthentifizierung.Enterprise-Pläne enthalten alle Authentifizierungsmethoden.
Bei aktivierter Authentifizierung müssen sich Benutzer anmelden, bevor sie auf Ihre Dokumentation zugreifen können.

​
Authentifizierungsmodi

Wählen Sie je nach Bedarf an Zugriffskontrolle zwischen vollständiger und partieller Authentifizierung. Vollständige Authentifizierung: Alle Seiten sind geschützt. Nutzer müssen sich anmelden, bevor sie auf Inhalte zugreifen können. Partielle Authentifizierung: Einige Seiten sind öffentlich zugänglich, während andere eine Anmeldung erfordern. Nutzer können öffentliche Inhalte frei durchsuchen und müssen sich nur beim Zugriff auf geschützte Seiten authentifizieren. Wenn Sie eine der unten genannten Handshake-Methoden konfigurieren, wählen Sie in den Dashboard-Einstellungen entweder Vollständige Authentifizierung oder Partielle Authentifizierung.

​
Authentifizierung konfigurieren

Wählen Sie die Handshake-Methode aus, die Sie konfigurieren möchten.
Die Passwort-Authentifizierung bietet lediglich Zugriffskontrolle und unterstützt keine Personalisierung von Inhalten.

​
Voraussetzungen

  • Ihre Sicherheitsanforderungen erlauben das gemeinsame Nutzen von Passwörtern durch Benutzer.

​
Implementierung

1

Passwort erstellen.

  1. Gehen Sie in Ihrem Dashboard zu Authentication.
  2. Wählen Sie Full Authentication oder Partial Authentication.
  3. Wählen Sie Password.
  4. Geben Sie ein sicheres Passwort ein.
  5. Wählen Sie Save changes.
2

Zugriff verteilen.

Teilen Sie das Passwort und die URL der Dokumentation sicher mit autorisierten Benutzern.

​
Beispiel

Ihre Dokumentation wird unter docs.foo.com gehostet und Sie benötigen eine grundlegende Zugriffskontrolle, ohne einzelne Benutzer nachzuverfolgen. Sie möchten den öffentlichen Zugriff verhindern und die Einrichtung dennoch einfach halten.Erstellen Sie ein starkes Passwort in Ihrem Dashboard. Teilen Sie die Zugangsdaten mit autorisierten Benutzern. Das war’s!

​
Seiten öffentlich machen

Bei Verwendung der Partiellen Authentifizierung sind standardmäßig alle Seiten geschützt. Mit der Eigenschaft public können Sie bestimmte Seiten auf Seiten- oder Gruppenebene ohne Authentifizierung zugänglich machen.

​
Seitenebene

Um eine Seite öffentlich zu machen, füge public: true zum Frontmatter der Seite hinzu.
Public page example
---
title: "Öffentliche Seite"
public: true
---

​
Gruppenebene

Um alle Seiten in einer Gruppe öffentlich zu machen, füge "public": true unter dem Gruppennamen im navigation-Objekt deiner docs.json hinzu.
Öffentliches Gruppenbeispiel
{
  "navigation": {
    "groups": [
      {
        "group": "Public group",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "Private group",
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}