Docker Compose Quickstart
Learn how to set-up and understand the benefits of Gitpod in less than 5 min with our Docker Compose template.
The following guide will:
- Walk you through a real world example with an existing Gitpod config
- Introduce you to prebuilds
- Demonstrate the benefits of ephemeral developer environments
For simplicity we use a GitHub template, but Gitpod works similarly with GitLab and Bitbucket.
Step 1: Clone Git repository
- Create a new repository based on the Docker Compose template.
- Name it e.g.
Step 2: Install the Gitpod app
Install the Gitpod App.
Gitpod’s GitHub app is similar to a CI server and will continuously prepare prebuilds for all your branches and pull requests - so you don’t have to wait for Maven or NPM downloading the internet when you want to start coding.
Step 3: First prebuild
- Start your first workspace with a prebuild by prefixing https://gitpod.io#prebuild/ to the URL of the repository.
The revised URL is:
Gitpod displays the prebuild progress status by running the
init commands in the .gitpod.yml file before you even start a workspace. Later, when you create a new workspace on a branch, or pull/merge request the workspace loads much faster, because all dependencies are already downloaded and the code is compiled. For more information see prebuilds.
Step 4: Enjoy being ready-to-code 🤙
Once the first prebuild ran, Gitpod starts an automated and fully configured developer environment in a workspace that is now ready for you to develop.
Other developers made their setup even more productive and supercharged their workflows with the following quick steps:
- Installing the browser extension
You can install the Gitpod browser extension on any Chromium-based browsers such as Microsoft Edge, Brave, Chrome, and others, or on a Firefox browser.
The extension simply adds a Gitpod button on every project and branch across GitHub, and Bitbucket that prefixes the URL with
gitpod.io/# so that you can easily open a new workspace from any Git context.
If you prefer to not install browser extensions then you can use the Gitpod browser bookmarklet instead.
For our partner GitLab we have a native integration into their UI that you can enable here.
- Add your favorite VS Code themes and extensions
You have access to all Visual Studio Code extensions published under the vendor neutral Open VSX registry. Install one by clicking the Extensions icon in the left sidebar and enter your favorite theme or VS Code extension.
Changes you make in your workspace such as themes and extensions are synced automatically to other workspaces.
- Start throwing away workspaces like paper towels
You can now start to treat dev environments as automated resources you spin up when you need them and close down (and forget about) when you are done with your task. Dev environments become fully ephemeral.
You even can start switching between workspaces or open several workspaces on the same context - two for your feature, one for reviewing a PR/MR, one for a bug, one for another MR/PR.
Try it out and open 3 workspaces on the same context (e.g. on main or on an issue). 🤓
You’ve successfully ran your first workspace and experienced first hand what we mean with ephemeral dev environments. This is just the first step on your journey towards being always ready to code. Helpful resources from here are: