Configuration de l'authentification

Contrôlez la confidentialité de votre documentation en authentifiant les utilisateurs

Les offres Pro incluent l’authentification par mot de passe.

Les offres Enterprise incluent toutes les méthodes d’authentification.

L’authentification requiert que les utilisateurs se connectent avant d’accéder à votre documentation.

​

Modes d’authentification

Choisissez entre l’authentification complète ou partielle en fonction de vos besoins en 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 pour accéder aux pages protégées.

Lors de la configuration de l’une des méthodes de handshake ci-dessous, sélectionnez Authentification complète ou Authentification partielle dans les paramètres du tableau de bord.

​

Configuration de l’authentification

Sélectionnez la méthode de handshake que vous souhaitez configurer.

Mot de passe

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é autorisent le partage de mots de passe entre utilisateurs.

​

Implémentation

1. Créer un mot de passe.

   1. Dans votre tableau de bord, accédez à Authentication.
   2. Sélectionnez Full Authentication ou Partial Authentication.
   3. Sélectionnez Password.
   4. Saisissez un mot de passe sécurisé.
   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 une configuration simple.

Créez un mot de passe robuste dans votre tableau de bord. Partagez les identifiants avec les utilisateurs autorisés. C’est tout !

​

Rendre des 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 avec la propriété public.

​

Niveau de la page

Pour rendre une page publique, ajoutez public: true au front matter de la page.

Exemple de page publique

---
title: "Page publique"
public: true
---

​

Niveau de 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": "Groupe public",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "Groupe privé"
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}