diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 673d0aa2a..f86df2b4f 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -10,7 +10,7 @@ keywords: ["preview URLs", "pull request previews", "branch previews", "staging Preview deployments let you see how changes to your docs look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes. -Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes. +Preview URLs are publicly viewable by default. You can [password-protect individual previews](#password-protect-a-preview) or [require organization sign-in](#require-organization-sign-in) to restrict access. ## Create preview deployments @@ -37,7 +37,12 @@ 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. Optionally, enable **Make private** to password-protect the preview. Enter a password with at least 8 characters. Anyone with the password can view the preview without needing a Mintlify account. +6. Select **Create deployment**. + + + Password-protected previews require the Pro plan or higher, and are only available when your site does not already have [authentication](/deploy/authentication-setup) enabled. + ## Redeploy a preview @@ -69,7 +74,20 @@ 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. There are two ways to restrict access: + +- **Password protection** — Set a password on individual manual previews so anyone with the password can view the preview. Useful for sharing with external reviewers who don't have a Mintlify account. +- **Preview authentication** — Require all preview viewers to sign in as members of your Mintlify organization. Applies to all preview deployments. + +### Password-protect a preview + +When [creating a manual preview](#manual-previews), enable **Make private** and set a password. Viewers must enter the password before they can access the preview URL. + +Password-protected previews are available on Pro and Enterprise plans. This option is not available when your site already has [authentication](/deploy/authentication-setup) enabled. + +### Require organization sign-in + +Restrict all preview deployments 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.