|
1 | 1 | --- |
2 | 2 | title: "Authentication setup" |
3 | | -description: "Guarantee privacy of your docs by authenticating users" |
| 3 | +description: "Control the privacy of your docs by authenticating users" |
4 | 4 | icon: "file-lock" |
5 | 5 | keywords: ['auth'] |
6 | 6 | --- |
7 | | -Authentication requires users to log in before accessing your documentation. This guide covers setup for each available handshake method. |
8 | | - |
9 | | -**Need help choosing?** See the [overview](/authentication-personalization/overview) to compare options. |
10 | 7 |
|
11 | 8 | <Info> |
12 | 9 | [Pro plans](https://mintlify.com/pricing?ref=authentication) include password authentication. |
13 | 10 |
|
14 | 11 | [Enterprise plans](https://mintlify.com/pricing?ref=authentication) include all authentication methods. |
15 | 12 | </Info> |
16 | 13 |
|
| 14 | +Authentication requires users to log in before accessing your documentation. |
| 15 | + |
| 16 | +## Authentication modes |
| 17 | + |
| 18 | +Choose between full and partial authentication modes based on your access control needs. |
| 19 | + |
| 20 | +**Full authentication**: All pages are protected. Users must log in before accessing any content. |
| 21 | + |
| 22 | +**Partial authentication**: Some pages are publicly viewable while others require authentication. Users can browse public content freely and authenticate only when accessing protected pages. |
| 23 | + |
| 24 | +When configuring any handshake method below, you'll select either **Full authentication** or **Partial authentication** in your dashboard settings. |
| 25 | + |
17 | 26 | ## Configuring authentication |
18 | 27 |
|
19 | 28 | Select the handshake method that you want to configure. |
@@ -240,3 +249,49 @@ When an unauthenticated user tries to access a protected page, their intended de |
240 | 249 | 4. User lands in their original destination. |
241 | 250 | </Tab> |
242 | 251 | </Tabs> |
| 252 | + |
| 253 | +## Making pages public |
| 254 | + |
| 255 | +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. |
| 256 | + |
| 257 | +### Page level |
| 258 | + |
| 259 | +To make a page public, add `public: true` to the page's frontmatter. |
| 260 | + |
| 261 | +```mdx Public page example |
| 262 | +--- |
| 263 | +title: "Public page" |
| 264 | +public: true |
| 265 | +--- |
| 266 | +``` |
| 267 | + |
| 268 | +### Group level |
| 269 | + |
| 270 | +To make all pages in a group public, add `"public": true` beneath the group's name in the `navigation` object of your `docs.json`. |
| 271 | + |
| 272 | +```json Public group example |
| 273 | +{ |
| 274 | + "navigation": { |
| 275 | + "groups": [ |
| 276 | + { |
| 277 | + "group": "Public group", |
| 278 | + "public": true, |
| 279 | + "icon": "play", |
| 280 | + "pages": [ |
| 281 | + "quickstart", |
| 282 | + "installation", |
| 283 | + "settings" |
| 284 | + ] |
| 285 | + }, |
| 286 | + { |
| 287 | + "group": "Private group", |
| 288 | + "icon": "pause", |
| 289 | + "pages": [ |
| 290 | + "private-information", |
| 291 | + "secret-settings" |
| 292 | + ] |
| 293 | + } |
| 294 | + ] |
| 295 | + } |
| 296 | +} |
| 297 | +``` |
0 commit comments