<aside> 🌍 This page is public. Read about our take on public when possible, private when necessary.


Notion header - Gitpod Adoption Stage 1 - Educate (1).jpg

This is Part 2 in a series that guides you through the different adoption phases towards cloud-based, remote software development for your team.

To setup Gitpod for your repository you create a .gitpod.yml configuration file at the root of your project to provide Gitpod with instructions on how to build and prepare the developer environment.

There is a simple rule: the better your Gitpod setup, the more pleasant the developer experience. Good news is that creating a top-notch configuration even for the most complex projects (think complexity of GitLab’s own source) should not take longer than a couple of hours.

We pasted below four open-source .gitpod.yml files as an inspiration. You can also find a multitude of them in our quickstart templates:

A good primer on the subject is the screencast below from our community engineer Pauline 👇


From there onwards the best resource we have is the Configure section in our docs. Something is missing? Please use the feedback widget at the bottom of the page and help us improve.

Configure Gitpod

If you are stuck while writing your .gitpod.yml feel free to reach out to us via Discord and/or contact us to schedule a joint session, where we can help optimizing your configuration.

To make the most efficient use of your time we are happy to send over a NDA and get access to your GitHub repository to do some of the heavy lifting for you.

We are here to help