Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,8 @@
"settings/versioning",
"settings/add-members",
"settings/github",
"settings/gitlab"
"settings/gitlab",
"settings/preview-deployments"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,35 +1,46 @@
---
title: 'Mintlify Dashboard Handshake'
description: 'Use the Mintlify Dashboard to authenticate users'
title: "Mintlify Dashboard Handshake"
description: "Use Mintlify to authenticate users"
---

<Info>
This is the documentation for the Mintlify Dashboard **Authentication** Handshake. The Mintlify Dashboard Handshake is not available for Personalization.
The Mintlify Dashboard Handshake is available only for Authentication, *not*
Personalization.
</Info>

If your documentation readers are also your documentation editors, you can allow Mintlify to manage access to your documentation. Anyone that can access
your dashboard will automatically be able to access your documentation.
You can use Mintlify to authenticate and manage access to your documentation. Anyone that can access your dashboard will automatically be able to see your documentation.

## Implementation
This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments.

<Steps>
<Step title="Configure your Authentication settings">
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and enable the Mintlify Dashboard Handshake.
</Step>
<Step title="Add users">
Ensure that any users that should be able to view your documentation have been added as users in your
[Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
</Step>
</Steps>
<Note>
Authentication is available only by request. Please{" "}
<a href="mailto:sales@mintlify.com">contact sales</a> for access. After we've
enabled access, you can follow the implementation instructions.
</Note>

## Example
### Example

I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs
to be internal, and the people that will be viewing my docs are the same people that
contribute to my docs.

To set up authentication with Mintlify, I go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication)
To set up authentication with Mintlify, I can go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication)
and enable Authentication with the Mintlify Dashboard Handshake.

I then ensure that anyone that should be able to read the docs has been added as a user in
I can then ensure that anyone that should be able to read the docs has been added as a user in
my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).

## Implementation

<Steps>
<Step title="Configure your Authentication settings">
Go to your [Mintlify dashboard
settings](https://dashboard.mintlify.com/products/authentication) and select
the Mintlify Auth Handshake.
</Step>
<Step title="Add users">
Ensure that any users that should be able to view your documentation have
been added as users in your [Mintlify dashboard
settings](https://dashboard.mintlify.com/settings/organization/members).
</Step>
</Steps>
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ If you don't have strict security requirements, or you don't want to manage a
database of documentation readers, you can use a set of shared passwords to
protect your docs.

<Note>
Authentication is available only by request. Please <a href="mailto:sales@mintlify.com">contact our sales team</a> for access. After we've enabled access, you can follow the implementation instructions.
</Note>

## Implementation

<Steps>
Expand Down
25 changes: 17 additions & 8 deletions settings/authentication-personalization/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
---
title: 'Authentication'
description: 'Features available with the Authentication product'
title: "Authentication"
description: "Guarantee privacy of your docs by authenticating users"
---

<Note>
Authentication is an enterprise feature. To get access, [contact sales](mailto:sales@mintlify.com).
Authentication is an enterprise feature. To get access, [contact
sales](mailto:sales@mintlify.com).
</Note>

As the name suggests, Authentication offers full privacy for all of your
documentation content. This includes all of the following:
Authentication offers full privacy for all of your
documentation content by requiring users to authenticate before viewing any content, such as:

- Documentation page content
- Images used in documentation pages
- Search results
- AI chat interactions

Authentication can be thought of as Personalization + privacy. In addition
You can authenticate users through handshake methods such as:

- [Password](./authentication-setup/password)
- [JWT](./authentication-setup/jwt)
- [OAuth](./authentication-setup/oauth)
- [Mintlify dashboard](./authentication-setup/mintlify)

Authentication is similar to our [Personalization](./personalization) offering, but with guaranteed privacy. In addition
to securing your documentation content, all features that are available via
Personalization are also available via Authentication. For more information
about the features of Personalization, [visit our docs on Personalization](./personalization).
Personalization are also available via Authentication.

Check out our docs for more info on [choosing Authentication vs Personalization](./authentication-vs-personalization).
24 changes: 24 additions & 0 deletions settings/preview-deployments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Preview Deployments"
description: "Preview changes to your docs in a live deployment"
icon: "street-view"
---

<Info>
Preview Deployments are available on the Growth and Enterprise plans. Please{" "}
<a href="mailto:sales@mintlify.com">contact sales</a> for more information.
</Info>

Preview Deployments allow you to preview changes to your docs in a live deployment without merging those changes to your production branch.

If you have created a pull or merge request when using Git, the generated preview URL will be available as a comment from the Mintlify bot in the PR. This URL will always reflect the latest deployment changes.

## Sharing Preview Deployments

After generating a preview URL, you can share that link with anybody for them to view.

### Authenticated Preview Deployments

If you'd like to restrict access to your Preview Deployments, you can set up preview deployment authentication. When using this authentication method, only Mintlify authenticated users will be able to access your Preview Deployments.

To set up preview deployment authentication, please [contact sales](mailto:sales@mintlify.com).
Loading