Planos Pro incluem autenticação por senha.Planos Enterprise incluem todos os métodos de autenticação.
A autenticação requer que os usuários efetuem login antes de acessar sua documentação.

​
Modos de autenticação

Escolha entre autenticação total ou parcial com base nas suas necessidades de controle de acesso. Autenticação total: Todas as páginas são protegidas. Os usuários devem fazer login antes de acessar qualquer conteúdo. Autenticação parcial: Algumas páginas são públicas, enquanto outras exigem autenticação. Os usuários podem navegar livremente pelo conteúdo público e só precisam se autenticar ao acessar páginas protegidas. Ao configurar qualquer método de handshake abaixo, selecione Autenticação total ou Autenticação parcial nas configurações do seu dashboard.

​
Configurando a autenticação

Selecione o método de handshake que você deseja configurar.
A autenticação por senha fornece apenas controle de acesso e não oferece suporte à personalização de conteúdo.

​
Pré-requisitos

  • Seus requisitos de segurança permitem o compartilhamento de senhas entre usuários.

​
Implementação

1

Crie uma senha.

  1. No seu dashboard, acesse Authentication.
  2. Selecione Full Authentication ou Partial Authentication.
  3. Selecione Password.
  4. Insira uma senha segura.
  5. Selecione Save changes.
2

Distribua o acesso.

Compartilhe, com segurança, a senha e a URL da documentação com usuários autorizados.

​
Exemplo

Sua documentação está hospedada em docs.foo.com e você precisa de um controle de acesso básico sem rastrear usuários individualmente. Você quer impedir o acesso público mantendo a configuração simples.Crie uma senha forte no seu dashboard. Compartilhe as credenciais com usuários autorizados. Só isso!

​
Tornando páginas públicas

Ao usar autenticação parcial, todas as páginas ficam protegidas por padrão. Você pode tornar páginas específicas acessíveis sem autenticação, no nível da página ou do grupo, usando a propriedade public.

​
Nível da página

Para deixar uma página pública, adicione public: true ao frontmatter da página.
Public page example
---
title: "Public page"
public: true
---

​
Nível de grupo

Para tornar todas as páginas de um grupo públicas, adicione "public": true logo abaixo do nome do grupo no objeto navigation do seu 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"
        ]
      }
    ]
  }
}