Skip to main content
Ask Peak to turn on Peakviews for your workspace.

​
Before you start

  • Sign in to Peak as an Admin.
  • Be an owner of your GitHub organization, or ask an owner to approve the Peakviews GitHub App.
  • Keep a supported setup on your default branch.

​
Turn on previews

  1. Open Previews.
  2. Choose Install on GitHub.
  3. Select your repositories on GitHub. Authorize Peakviews when GitHub asks, then return to Peak.
  4. Open a repository.
  5. Under Setup, check the Source, Public, Services, and Databases that Peak found.
  6. Under Keys, enter each key marked Missing and choose Save. Or choose Paste .env or Import from Render.
  7. Choose Turn on previews.
Choose Skip beside a key that previews don’t need. Choose Add repositories to change the selection on GitHub. Already installed on GitHub? Choose Install on GitHub to connect it.

​
Open a pull request

Push a branch to the same repository. Open a pull request from it. Check these on the pull request. Expect no preview for pull requests from forks.

​
Fix a failed preview

Open the Peakviews check and read the log.