Les offres Pro incluent l’authentification par mot de passe.Les offres Enterprise incluent l’ensemble des méthodes d’authentification.
L’authentification impose aux utilisateurs de se connecter avant d’accéder à votre documentation.

​
Modes d’authentification

Choisissez entre une authentification complète ou partielle en fonction de vos besoins en matière de contrôle d’accès. Authentification complète : toutes les pages sont protégées. Les utilisateurs doivent se connecter avant d’accéder à tout contenu. Authentification partielle : certaines pages sont publiques, tandis que d’autres nécessitent une authentification. Les utilisateurs peuvent parcourir librement le contenu public et ne s’authentifier que lorsqu’ils accèdent à des pages protégées. Lors de la configuration de l’une des méthodes de handshake ci-dessous, vous sélectionnerez soit Authentification complète soit Authentification partielle dans les paramètres de votre tableau de bord.

​
Configuration de l’authentification

Sélectionnez la méthode de négociation (handshake) que vous souhaitez configurer.
L’authentification par mot de passe assure uniquement le contrôle d’accès et ne prend pas en charge la personnalisation du contenu.

​
Prérequis

  • Vos exigences de sécurité permettent le partage de mots de passe entre utilisateurs.

​
Mise en œuvre

1

Créer un mot de passe.

  1. Dans votre tableau de bord, rendez-vous sur Authentication.
  2. Sélectionnez Full Authentication ou Partial Authentication.
  3. Sélectionnez Password.
  4. Saisissez un mot de passe fort.
  5. Sélectionnez Save changes.
2

Distribuer l’accès.

Partagez en toute sécurité le mot de passe et l’URL de la documentation avec les utilisateurs autorisés.

​
Exemple

Votre documentation est hébergée sur docs.foo.com et vous avez besoin d’un contrôle d’accès simple sans suivi des utilisateurs individuellement. Vous souhaitez empêcher l’accès public tout en gardant la configuration simple.Créez un mot de passe fort dans votre tableau de bord. Partagez les identifiants avec les utilisateurs autorisés. Et c’est tout !

​
Rendre les pages publiques

Lorsque vous utilisez l’authentification partielle, toutes les pages sont protégées par défaut. Vous pouvez rendre certaines pages accessibles sans authentification, au niveau de la page ou du groupe, à l’aide de la propriété public.

​
Au niveau de la page

Pour rendre une page publique, ajoutez public: true au frontmatter de la page.
Public page example
---
title: "Public page"
public: true
---

​
Au niveau du groupe

Pour rendre toutes les pages d’un groupe publiques, ajoutez "public": true sous le nom du groupe dans l’objet navigation de votre docs.json.
Exemple de groupe public
{
  "navigation": {
    "groups": [
      {
        "group": "Public group",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "Private group",
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}