Skip to content

Commit 3d7ad7a

Browse files
devin-ai-integration[bot]fern-supportdevalog
authored
docs: add password protection authentication documentation (#3331)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Fern Support <info@buildwithfern.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent 0c48135 commit 3d7ad7a

File tree

3 files changed

+30
-11
lines changed

3 files changed

+30
-11
lines changed

fern/products/docs/docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,8 @@ navigation:
299299
path: ./pages/api-references/autopopulate-api-key.mdx
300300
- page: SSO
301301
path: ./pages/authentication/sso.mdx
302+
- page: Password protection
303+
path: ./pages/authentication/password.mdx
302304
- section: Security
303305
collapsed: true
304306
contents:

fern/products/docs/pages/authentication/overview.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,29 @@ title: Overview of authentication options
33
description: Understand the different authentication options Fern offers
44
---
55

6-
Fern offers two methods of authentication, Single Sign-On (SSO) and Role-Based Access Control (RBAC).
6+
Fern supports three ways to restrict access to your documentation:
77

8-
**For most situations, use RBAC** for granular access control over your documentation. RBAC works well for sites with multiple audiences (internal teams, partners, customers) and supports API key injection to autopopulate code examples.
9-
10-
API key injection can be set up using either JWT or OAuth, depending on your existing authentication system.
11-
12-
**SSO is simpler** but only provides basic login functionality - it doesn't support RBAC or API key injection. SSO works well for internal-only documentation where everyone should see the same content.
8+
- **RBAC** — Control which content different users can see. Supports [API key injection](/learn/docs/authentication/api-key-injection) via JWT or OAuth. Recommended for most use cases.
9+
- **SSO** — Require login without role management. Good for internal docs where all users see the same content.
10+
- **Password protection** — A single shared password for the entire site. Good for pre-release docs or basic access restriction.
1311

1412
<Note>
1513
Learn how Fern handles user credentials and authentication in the [Security overview](/learn/docs/security/overview).
1614
</Note>
1715

1816
Learn more about Fern's authentication options:
1917

20-
<CardGroup cols={3}>
21-
<Card title="Role-based access control" icon="fa-duotone fa-people-group" href="/docs/authentication/rbac">
18+
<CardGroup cols={2}>
19+
<Card title="Role-based access control" icon="fa-duotone fa-people-group" href="/learn/docs/authentication/rbac">
2220
Granular access for different audiences
2321
</Card>
24-
<Card title="API Key Injection" icon="fa-duotone fa-key" href="/docs/authentication/api-key-injection">
22+
<Card title="API key injection" icon="fa-duotone fa-key" href="/learn/docs/authentication/api-key-injection">
2523
JWT or OAuth flows available
2624
</Card>
27-
<Card title="SSO" icon="fa-duotone fa-user-check" href="/docs/authentication/sso">
25+
<Card title="SSO" icon="fa-duotone fa-user-check" href="/learn/docs/authentication/sso">
2826
Basic functionality and simple setup
2927
</Card>
30-
</CardGroup>
28+
<Card title="Password protection" icon="fa-duotone fa-lock" href="/learn/docs/authentication/password-protection">
29+
Shared password for simple access control
30+
</Card>
31+
</CardGroup>
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Password protection
3+
subtitle: Protect your documentation site with a shared password for simple access control.
4+
---
5+
6+
<Markdown src="/snippets/enterprise-plan.mdx"/>
7+
8+
Password protection allows you to restrict access to your documentation site using a shared password. This is useful for pre-release documentation, internal resources, or any content you want to keep private without requiring individual user accounts.
9+
10+
## How it works
11+
12+
When password protection is enabled, visitors to your documentation site are prompted to enter a password before they can view any content. Once authenticated, users can browse the site until their session expires.
13+
14+
## Setting up password protection
15+
16+
To enable password protection for your documentation site, [contact Fern](https://buildwithfern.com/contact) or reach out via Slack. Fern will configure the password for your site.

0 commit comments

Comments
 (0)