Q: How to set a deployment's entry path

The entry path is the initial route your deployment's visitors will land on when reviewing your pull request on FeaturePeek. If your front-end changes only affect the appearance of your website's blog, then you can point the entry path to <code>/blog</code> in order to save your reviewers a click or two. This also updates the thumbnail in <a href="https://dashboard.featurepeek.com">your team's Dashboard</a> so that you can easily identify it among other open pull requests. The easiest way to set the entry path is while you're creating the pull request. Simply include <code>@featurepeek /path/to/my/page</code> anywhere in the pull request body, and FeaturePeek will set the entry path for you. You can also edit the pull request body after the PR is opened, or leave a comment on the PR, and the entry path will be set to the value you @reply the FeaturePeek bot with. <img src="https://storage.crisp.chat/users/helpdesk/website/eb4827004f14f000/528-f3fd7ba8332fc976fa983471cb_1or6gmg.png" alt="" /> You can also set the entry path in the deployment's settings by clicking its ellipsis menu (<code>...</code>) in the Dashboard.

Q: How to set environment variables

If you specified <code>type: docker</code> in your project's <code>peek.yml</code> file, you have the ability to modify runtime environment variables for each of your project's deployments. Depending on your code, some environment variables may be required for your application to boot up and/or behave correctly. On your team's <a href="https://dashboard.featurepeek.com">Dashboard</a>, click the Settings icon next to your project's name. <img src="https://storage.crisp.chat/users/helpdesk/website/eb4827004f14f000/screen-shot-2020-01-28-at-4412_13pddbf.png" alt="" /> Then, scroll down to the "Environment variables" section. Add any key/value pairs you'd like – the keys and values should be separated by an equals sign (<code>=</code>), and each key/value pair should be on its own line. If you have a <code>.env</code> file that you gitignore, you can paste the whole thing in this text area. <img src="https://storage.crisp.chat/users/helpdesk/website/eb4827004f14f000/screen-shot-2020-01-28-at-4350_lsfykl.png" alt="" /> Changes you make to your project's environment variables will propagate down to any running deployments within that project. You may need to <a href="/en/article/how-to-restart-a-deployment-1dpl6x7/">restart your deployments</a> for those changes to take effect. If you only want to apply a new set of environment variables for one particular environment, and not the whole project, you can do so in the deployment settings. Click the ellipsis icon (<code>...</code>) on the top right of the card to access the dropdown menu. Then access the environment variables a

Q: How to create a new team

A team on FeaturePeek is tied to a GitHub organization or personal account. There can only be one GitHub organization/account per FeaturePeek team. Every FeaturePeek user is a part of at least one team, whether or not there are other people on the team. When you create a new FeaturePeek account, you can either create a new team, or join an existing one. At any time, you can create a new team by clicking the Plus icon in the bottom left of your <a href="https://dashboard.featurepeek.com">Dashboard</a>. <img src="https://storage.crisp.chat/users/helpdesk/website/eb4827004f14f000/screen-shot-2020-01-27-at-1148_4ngo7h.png" alt="Click the plus icon to create a new team" /> You'll need to install the GitHub app on the organization or account that you intend to link. You will need to have admin privileges on GitHub in order to do so. Next, you'll select one organization or account to link with your FeaturePeek team. If you do not see the organization or account appear, you may need to <a href="https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization">disable third-party OAuth restrictions on GitHub</a>. <img src="https://storage.crisp.chat/users/helpdesk/website/eb4827004f14f000/screen-shot-2020-01-27-at-1153_od1oqz.png" alt="" /> After you link your FeaturePeek team with a GitHub integration, you'll be asked to create a subscription. If you'd like to use FeaturePeek on a private repo, select the Business Plan (either mon

Question 1

How to set a deployment's entry path

Accepted Answer

The entry path is the initial route your deployment's visitors will land on when reviewing your pull request on FeaturePeek. If your front-end changes only affect the appearance of your website's blog, then you can point the entry path to /blog in order to save your reviewers a click or two. This also updates the thumbnail in your team's Dashboard so that you can easily identify it among other open pull requests.

The easiest way to set the entry path is while you're creating the pull request. Simply include @featurepeek /path/to/my/page anywhere in the pull request body, and FeaturePeek will set the entry path for you. You can also edit the pull request body after the PR is opened, or leave a comment on the PR, and the entry path will be set to the value you @reply the FeaturePeek bot with.

You can also set the entry path in the deployment's settings by clicking its ellipsis menu (...) in the Dashboard.

Question 2

What do these error messages mean?

Accepted Answer

While your environment is booting up, it streams a message indicating the status of the boot phase. If something goes wrong, the status will turn red (in both the status section of the pull request on GitHub, and on your team's Dashboard) and an error message will be displayed. Continue reading to learn more detail about each error message, and what you can do to fix it.

Error status messages

Deployment unreachable. Please check port. This message occurs when the port exposed in your Dockerfile doesn't match the port you set in your peek.yml file.

Error connecting to docker registry. Double-check that the required environment variables exist in the context of your CI environment, and that they are set to the right values. The required environment variables differ for each container registry – here they are for ECR, GCR, Docker Hub, and GitHub Packages.

Health check response contains invalid HTTP headers. Because FeaturePeek runs your code within an iframe, the following HTTP response headers are not allowed:

X-Frame-Options: A value of deny or sameorigin will prevent FeaturePeek from working properly. It's recommended to use the frame-ancestors directive

Question 3

How to set environment variables

Accepted Answer

If you specified type: docker in your project's peek.yml file, you have the ability to modify runtime environment variables for each of your project's deployments. Depending on your code, some environment variables may be required for your application to boot up and/or behave correctly.

On your team's Dashboard, click the Settings icon next to your project's name.

Then, scroll down to the "Environment variables" section. Add any key/value pairs you'd like – the keys and values should be separated by an equals sign (=), and each key/value pair should be on its own line. If you have a .env file that you gitignore, you can paste the whole thing in this text area.

Changes you make to your project's environment variables will propagate down to any running deployments within that project. You may need to restart your deployments for those changes to take effect.

If you only want to apply a new set of environment variables for one particular environment, and not the whole project, you can do so in the deployment settings. Click the ellipsis icon (...) on the top right of the card to access the dropdown menu. Then access the environment variables a

Question 4

How to restart a deployment

Accepted Answer

Sometimes it's helpful to restart a deployment – for example, when you recently edited a project's runtime environment variables.

You can shut down a running deployment by selecting "Pause" from a deployment's ellipsis (...) menu. Shutting down the deployment will kick out any reviewer currently looking at it, so be sure that no one on your team is doing anything important in that particular deployment.

Once it's shut down, you can restart it by clicking anywhere on the card, or by selecting "Resume" from the ellipsis menu.

Question 5

How to create a new team

Accepted Answer

A team on FeaturePeek is tied to a GitHub organization or personal account. There can only be one GitHub organization/account per FeaturePeek team. Every FeaturePeek user is a part of at least one team, whether or not there are other people on the team.

When you create a new FeaturePeek account, you can either create a new team, or join an existing one.

At any time, you can create a new team by clicking the Plus icon in the bottom left of your Dashboard.

Click the plus icon to create a new team

You'll need to install the GitHub app on the organization or account that you intend to link. You will need to have admin privileges on GitHub in order to do so.

Next, you'll select one organization or account to link with your FeaturePeek team. If you do not see the organization or account appear, you may need to disable third-party OAuth restrictions on GitHub.

After you link your FeaturePeek team with a GitHub integration, you'll be asked to create a subscription. If you'd like to use FeaturePeek on a private repo, select the Business Plan (either mon

Question 6

How to install the GitHub app

Accepted Answer

Installing the FeaturePeek GitHub app is the first step of setting up your team's first project. This lets FeaturePeek listen to your repo's webhook events and gives the FeaturePeek bot permission to write comments on your pull requests.

You must have admin privileges on your GitHub organization to install apps on it. Check with an admin on your team if you have insufficient permissions.

It's up to you whether you'd like to install the GitHub app on your organization, or on one particular repo. We recommend installing on your org, so that you don't have to change things later if you want to create more projects later.

Frequently Read Articles

Browse All Categories