Skip to content

Document password-protected preview deployments #5119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

Document password-protected preview deployments #5119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 21 additions & 3 deletions deploy/preview-deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@

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

Preview deployments are created automatically through pull requests or manually from your dashboard.

Check warning on line 17 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L17 

In general, use active voice instead of passive voice ('are created').

### Automatic previews

Expand All @@ -37,14 +37,19 @@
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**.

<Note>
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.
</Note>

## Redeploy a preview

Check warning on line 47 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L47 

Use 'redeploy(s|ed|ing)?' instead of 'Redeploy'.

Redeploy a preview to refresh content or retry after a failed deployment.

Check warning on line 49 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L49 

Use 'redeploy(s|ed|ing)?' instead of 'Redeploy'.

1. Select the preview from your [dashboard](https://dashboard.mintlify.com/).
2. Select **Redeploy**.

Check warning on line 52 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L52 

Use 'redeploy(s|ed|ing)?' instead of 'Redeploy'.

<Frame>
<img src="/images/previews/redeploy-preview-light.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="block dark:hidden" />
Expand All @@ -69,7 +74,20 @@

## 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.

Check warning on line 79 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L79 

Don't put a space before or after a dash.
- **Preview authentication** — Require all preview viewers to sign in as members of your Mintlify organization. Applies to all preview deployments.

Check warning on line 80 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L80 

Don't put a space before or after a dash.

### 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.
Expand Down
Loading