diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 673d0aa2a..082d36bd9 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -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 @@ -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. @@ -78,6 +82,25 @@ By default, preview deployments are publicly accessible to anyone with the URL. The preview authentication toggle in the Add-ons page +### Password-protect an individual preview + + + Password-protected previews are available on [Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). + + +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. + + The Create a custom preview modal with the Make private toggle enabled and a password field. + The Create a custom preview modal with the Make private toggle enabled and a password field. + +6. Select **Create preview**. + ## Troubleshooting preview deployments If your preview deployment fails, try these troubleshooting steps. diff --git a/images/previews/private-preview-dark.png b/images/previews/private-preview-dark.png new file mode 100644 index 000000000..c72134fc5 Binary files /dev/null and b/images/previews/private-preview-dark.png differ diff --git a/images/previews/private-preview-light.png b/images/previews/private-preview-light.png new file mode 100644 index 000000000..43fe7b4a1 Binary files /dev/null and b/images/previews/private-preview-light.png differ