Skip to main content

​
Overview

Mintlify supports password protection for your documentation site. This feature requires a Pro or Custom plan (paid feature).

​
Setup Instructions

​
Step 1: Upgrade to Pro Plan

  1. Go to your Mintlify Dashboard
  2. Navigate to Settings → Billing
  3. Upgrade to Pro or Custom plan

​
Step 2: Configure Password Authentication

  1. In your Mintlify Dashboard, go to Settings → Authentication
  2. Choose authentication type:
    • Full Authentication: Protects all pages
    • Partial Authentication: Protects only specific pages
  3. Select Password as the authentication method
  4. Set a secure password:
    • Use a strong password (mix of letters, numbers, symbols)
    • Consider using a password manager to generate one
  5. Save the configuration

​
Step 3: Distribute Access

  • Share the documentation URL with authorized users
  • Provide the password securely (via secure email, password manager, etc.)
  • Users will be prompted for the password when accessing the docs

​
Alternative Options

​
Option 1: Custom Domain with Access Control

If you host Mintlify on a custom domain, you can:
  • Use your own authentication layer (e.g., Cloudflare Access)
  • Set up IP whitelisting at the DNS/CDN level
  • Use SSO providers

​
Option 2: Private GitHub Repository

  • Keep the docs repository private
  • Only grant access to authorized GitHub users
  • Mintlify will automatically sync with your private repo

​
Option 3: Conditional Access

For Custom plan users, you can implement:
  • OAuth 2.0 authentication
  • JWT token validation
  • Custom authentication logic

​
Security Best Practices

  1. Strong Password: Use a password manager to generate a strong password
  2. Regular Rotation: Change the password periodically
  3. Limit Access: Only share with authorized personnel
  4. Monitor Usage: Check Mintlify analytics for unusual access patterns
  5. Two-Factor: Consider using 2FA for your Mintlify account

​
Troubleshooting

Issue: Users can’t access the docs
  • Solution: Verify the password is correct and authentication is enabled
Issue: Password prompt not appearing
  • Solution: Check that authentication is enabled in dashboard settings
  • Clear browser cache and cookies
Issue: Need different passwords for different sections
  • Solution: Use Partial Authentication on Custom plan to protect specific pages

​
Need Help?