Signing up with GitHub

Squash only requests the absolutely minimum set of permissions on GitHub. When you signup you will be prompted to the following screens:


This is the standard GitHub authorization page requesting your permission to give Squash access to your account. We only request read access to basic information. You may also grant access to any organizations to work with in Squash. Organizations will be listed under the “Organization access” area in this page.

  • Squash needs your email address in order to communicate with you in the future for any customer support or billing issues.
  • We ask for basic information on organizations and teams so you can easily invite team members to your Squash account.

GitHub Application

This is where you can authorize the repositories you want to provide access to Squash.

  • We need read access to the code so we can pull a branch of code during a deployment.
  • We also ask for read and write access to pull requests so Squash can automatically add a comment with  a deployment URL.


Organizations & Personal Account

You can manage your own GitHub personal account and multiple organizations as well. Each organization will have its own separate billing though.

Contact our support team if you need a different billing arrangement or merging the billing of multiple organizations.

After signing up

After you sign up Squash will prompt you with a repository setup page where you can run your first deployment. Just follow the directions in the UI and you should be quickly up and running. Do you have any questions or require assistance? reach out to our support team and we will be happy to help.

Using private repositories?

If you are using private repositories we also recommend adding the Squash Deployment Keys into each of your GitHub private repositories.