Getting Started

When you sign up you automatically get access to the Squash’s admin interface. This is where you can manage all your repositories, deployments, user accounts, account settings, billing and more. Multiple organizations and personal accounts Squash supports managing multiple organizations under the same user account. You just need to be a member of an organization already signed up in Squash. At the...

Read more

Squash runs your deployments on virtual machines that are commissioned exclusively for you. Each deployment is created from scratch with a clean state. Docker containers Each Squash deployment has at least one Docker container (multiple containers if you are using docker-compose). Even if your application setup is based on a .squash.yml file (no Docker files) Squash still creates a Docker containe...

Read more

Before starting, make sure you have at least one Git repository enabled in your account. Check out this page for more details on activating Git repositories. Using the Deployment UI To start your first deployment go to the Active Deployments page and then click on the "New Deployment" Button: Then Select a repository and branch: After you click "Next" Squash will look for a Squash YAML file or Doc...

Read more

A Squash deployment consists of a at least one unique virtual machine associated with a branch of code. By default, if you have only one unique web app within a repository, Squash will commission one virtual machine for each branch of code. You can commission as many virtual machines as you like within your plan's concurrency limit and limit of hours. Squash also supports running multiple virtual ...

Read more

Squash makes it very easy to seed development databases. You can use your own sanitized data set or even clone production dumps (although in some cases this might not be recommend, see below). The way it works is based on importing a development db dump from any SQL or non-SQL database engines (MySQL, PostgreSQL, MongoDB, etc) and then caching that data into Squash so that you don't need to do a f...

Read more

This is how a typical Squash deployment URL looks like: When you click on such URLs Squash will immediately start the deployment process for the branch of code associated with this URL. However, there are a few different scenarios that will affect how you see the progress of the deployment process. Users authenticated in Squash If you are currently logged in Squash then you will see the full deplo...

Read more

From the Squash Dashboard you can see each active deployment across all repositories and team members in your organization. Each deployment is displayed with a status indicating its execution stage: Here is a description of how each stage works: Running (green): Squash has received a success response and your application is up and running, ready to be used. Building (blue): Squash has initiated th...

Read more

A Squash deployment consists of brand new virtual machines for each branch of code. Each deployment has its own unique URL. Custom domains and custom SSL certificates are also supported. Structure of a Squash deployment URL: $ https://<branch-name>-<squash-unique-id>.squash.io Example: https://cartv3-improvements-i3xg7.squash.io For the example above we have the following: The original branch name...

Read more

Squash has native support for self-hosted GitLab instances, all Squash features are available in this integration. To get start first go to the Squash Sign up page, click on "Signup with GitLab" and then "GitLab Self-hosted" in the next page. Then click on the highlighted link to setup your GitLab access: The next step is to register Squash within your GitLab instance by following the steps below....

Read more

Squash only requests the absolutely minimum set of permissions on GitLab. We support both GitLab Cloud and GitLab Self-hosted. GitLab Self-Hosted Setup Please follow the steps on this page for GitLab Self-Hosted. GitLab Cloud When you signup you will be prompted to the following screens: Oauth This is the standard GitLab authorization page requesting your permission to give Squash access to your a...

Read more

Squash only requests the absolutely minimum set of permissions on Bitbucket. When you signup you will be prompted to the following screens: Oauth This is the standard Bitbucket authorization page requesting your permission to give Squash access to your account. Squash needs your email address in order to communicate with you in the future for any customer support or billing issues. We ask for basi...

Read more

Squash only requests the absolutely minimum set of permissions on GitHub. When you signup you will be prompted to the following screens: Oauth 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 l...

Read more

Programming Languages and Software Stack Squash works with any programming languages and software services supported in a Linux Environment. You also need a Git code repository with a working web application. Squash supports unlimited public and private repositories on any of our plans, including the free plan. Hosted Code Repository Squash integrates with GitHub, GitLab and Bitbucket. Squash onl...

Read more

Sample YAML file configurations Please visit this page for a list of the most common use cases and configurations in Squash. How It Works Squash works by creati ...

Read more