You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: protected-pages/password-protection.mdx
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,14 @@ description: "Restrict access to your documentation with a password"
4
4
icon: "rectangle-ellipsis"
5
5
---
6
6
7
-
TODO: add a description of when and why you'd use password protection
7
+
Password protection provides simple access control using a single shared password. All authorized users use the same password to access your documentation.
8
+
9
+
Use password protection when you need basic security for your docs.
8
10
9
11
## Prerequisites
10
12
11
-
* Your security requirements allow sharing passwords among users.
13
+
- You are on a Pro or Enterprise plan
14
+
- You can securely distribute passwords to authorized users
12
15
13
16
## Implementation
14
17
@@ -21,13 +24,18 @@ TODO: verify steps with new UI
21
24
3. Enter a secure password.
22
25
4. Select **Save changes**.
23
26
</Step>
27
+
<Steptitle="Test access.">
28
+
Open your documentation in an incognito window to verify the password prompt appears and your password works.
29
+
</Step>
24
30
<Steptitle="Distribute access.">
25
31
Securely share the password and documentation URL with authorized users.
26
32
</Step>
27
33
</Steps>
28
34
29
-
## Example scenario
30
-
31
-
You need basic access control without tracking individual users. You want to prevent public access while keeping setup simple. Your user base is small and trusted, so you can share a single password with all users.
35
+
## Security considerations
32
36
33
-
**Create a strong password** in your dashboard. **Share credentials** with authorized users. Rotate the password regularly and you are all set.
37
+
- Rotate passwords regularly.
38
+
- Use a strong, unique password.
39
+
- Distribute passwords through secure channels like password managers or encrypted communication.
40
+
- Change the password immediately if someone loses access privileges.
41
+
- Change the password immediately if you need to revoke access.
0 commit comments