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
27 changes: 25 additions & 2 deletions deploy/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can manually create a preview for any branch.
2. Select **Previews**.
3. Select **Create custom preview**.
4. Enter the name of the branch you want to preview.
5. Select **Create deployment**.
5. Select **Create preview**.

## Redeploy a preview

Expand Down Expand Up @@ -69,7 +69,11 @@ The widget only appears on preview deployments, not on your live site or local p

## Restrict access to preview deployments

By default, preview deployments are publicly accessible to anyone with the URL. You can restrict access to authenticated members of your Mintlify organization.
By default, preview deployments are publicly accessible to anyone with the URL. You can restrict access by requiring organization authentication for all previews or by password-protecting individual previews.

### Require organization authentication

Restrict preview access to authenticated members of your Mintlify organization.

1. Navigate to the **Previews** section in the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard.
2. Click the **Preview authentication** toggle to enable or disable preview authentication.
Expand All @@ -78,6 +82,25 @@ By default, preview deployments are publicly accessible to anyone with the URL.
<img src="/images/previews/preview-auth-dark.png" alt="The preview authentication toggle in the Add-ons page" className="hidden dark:block" />
</Frame>

### Password-protect an individual preview

<Info>
Password-protected previews are available on [Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments).
</Info>

Password-protect a specific preview to share it with external reviewers without adding them to your Mintlify organization. This option is available when creating a manual preview and is not shown when organization authentication is already enabled for your deployment.

1. Go to your [dashboard](https://dashboard.mintlify.com/).
2. Select **Previews**.
3. Select **Create custom preview**.
4. Enter the name of the branch you want to preview.
5. Toggle **Make private** on and enter a password. Passwords must be at least 8 characters.
<Frame>
<img src="/images/previews/private-preview-light.png" alt="The Create a custom preview modal with the Make private toggle enabled and a password field." className="block dark:hidden" />
<img src="/images/previews/private-preview-dark.png" alt="The Create a custom preview modal with the Make private toggle enabled and a password field." className="hidden dark:block" />
</Frame>
6. Select **Create preview**.

## Troubleshooting preview deployments

If your preview deployment fails, try these troubleshooting steps.
Expand Down
Binary file added images/previews/private-preview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/previews/private-preview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading