Authentication setup

Control the privacy of your docs by authenticating users

Pro plans include password authentication.

Enterprise plans include all authentication methods.

Authentication requires users to log in before accessing your documentation.

Authentication modes

Choose between full and partial authentication modes based on your access control needs.

Full authentication: All pages are protected. Users must log in before accessing any content.

Partial authentication: Some pages are publicly viewable while others require authentication. Users can browse public content freely and authenticate only when accessing protected pages.

When configuring any handshake method below, you’ll select either Full authentication or Partial authentication in your dashboard settings.

Configuring authentication

Select the handshake method that you want to configure.

Password

Password authentication provides access control only and does not support content personalization.

Prerequisites

• Your security requirements allow sharing passwords among users.

Implementation

1. Create a password.

   1. In your dashboard, go to Authentication.
   2. Select Full Authentication or Partial Authentication.
   3. Select Password.
   4. Enter a secure password.
   5. Select Save changes.
2. Distribute access.

   Securely share the password and documentation URL with authorized users.

Example

Your documentation is hosted at docs.foo.com and you need basic access control without tracking individual users. You want to prevent public access while keeping setup simple.

Create a strong password in your dashboard. Share credentials with authorized users. That’s it!

Making pages public

When using partial authentication, all pages are protected by default. You can make specific pages viewable without authentication at the page or group level with the public property.

Page level

To make a page public, add public: true to the page’s frontmatter.

Public page example

---
title: "Public page"
public: true
---

Group level

To make all pages in a group public, add "public": true beneath the group’s name in the navigation object of your 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"
        ]
      }
    ]
  }
}