Los planes Pro incluyen autenticación con contraseña.Los planes Enterprise incluyen todos los métodos de autenticación.
La autenticación exige que los usuarios inicien sesión antes de acceder a tu documentación.

​
Modos de autenticación

Elige entre autenticación completa o parcial según tus necesidades de control de acceso. Autenticación completa: Todas las páginas están protegidas. Los usuarios deben iniciar sesión antes de acceder a cualquier contenido. Autenticación parcial: Algunas páginas son públicas mientras que otras requieren autenticación. Los usuarios pueden navegar libremente el contenido público y autenticarse solo al acceder a páginas protegidas. Al configurar cualquiera de los métodos de handshake a continuación, selecciona Autenticación completa o Autenticación parcial en la configuración del panel.

​
Configurar la autenticación

Selecciona el método de handshake que deseas configurar.
La autenticación con contraseña ofrece únicamente control de acceso y no admite la personalización de contenido.

​
Requisitos previos

  • Tus políticas de seguridad permiten compartir contraseñas entre usuarios.

​
Implementación

1

Crea una contraseña.

  1. En tu panel, ve a Authentication.
  2. Selecciona Full Authentication o Partial Authentication.
  3. Selecciona Password.
  4. Introduce una contraseña segura.
  5. Selecciona Save changes.
2

Distribuye el acceso.

Comparte de forma segura la contraseña y la URL de la documentación con los usuarios autorizados.

​
Ejemplo

Tu documentación está alojada en docs.foo.com y necesitas un control de acceso básico sin hacer seguimiento de usuarios individuales. Quieres impedir el acceso público manteniendo una configuración sencilla.Crea una contraseña segura en tu panel. Comparte las credenciales con los usuarios autorizados. ¡Listo!

​
Hacer públicas las páginas

Al usar autenticación parcial, todas las páginas están protegidas de forma predeterminada. Puedes hacer que páginas específicas sean visibles sin autenticación, ya sea a nivel de página o de grupo, usando la propiedad public.

​
A nivel de página

Para que una página sea pública, agrega public: true al frontmatter de la página.
Public page example
---
title: "Página pública"
public: true
---

​
A nivel de grupo

Para hacer públicas todas las páginas de un grupo, agrega "public": true debajo del nombre del grupo en el objeto navigation de tu docs.json.
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"
        ]
      }
    ]
  }
}