- Configure Your Project
- Docker Configuration
- Start Tasks
- VS Code Extensions
- Exposing Ports
- Prebuilt Workspaces
- Environment Variables
- Workspace Location
- Editor Configuration
- Gitpod Self-Hosted
- Install on Google Cloud Platform
- Install on Amazon Web Services
- Install on self-managed Kubernetes
- Configure OAuth
- Configure a Domain
- Configure HTTPS Certificates
- Configure a Database
- Configure a Docker Registry
- Configure Storage
- Configure Nodes
- Configure Workspaces
- Languages & Frameworks
This guide explains how to install an instance of Gitpod with 3 simple steps:
export AWS_ACCESS_KEY_ID=... export AWS_SECRET_ACCESS_KEY=...
- Setting up an AWS account the first time can take some time as they require - and test for - a valid credit card.
docker run --rm -it \ -e AWS_ACCESS_KEY_ID \ -e AWS_SECRET_ACCESS_KEY \ -v "$PWD/awsinstall":"/workspace" \ eu.gcr.io/gitpod-io/self-hosted/installer:latest aws
This will kickstart the installation process, authenticate with AWS and automatically set up your Gitpod deployment using Docker and Terraform.
- This guide assumes you have the docker installed.
- The final step - creating the cluster - might take around 30 minutes on AWS. Good time to grab a cup of coffee!
Once finished, the installer will print the URL at which your Gitpod installation can be found. There you need to connect Gitpod to at least one Git provider:
Afterwards you can jump right into your first workspace, by prefixing the repository URL with your Gitpod Self-Hosted URL.
- The local mount point
./awsinstallwill hold your Terraform config files. You can always modify them and re-run the install script in order to make changes to your Gitpod deployment.
- The first workspace start might take a up to 10 minutes because it needs to pull several docker images and initialize the registry.
Q: I get “OptInRequired: You are not subscribed to this service. Please go to http://aws.amazon.com to subscribe.”
A: Your account seems to be missing a credit card. Go to https://portal.aws.amazon.com/billing/signup?type=resubscribe#/resubscribed and finish the subscription process.
A: Switch to another AWS region often helps. Some machine types/configurations are not available in all regions.
Q: I get “Error: Service “proxy” is invalid: spec.ports.nodePort: Invalid value: 31080: provided port is already allocated” on re-applying the terraform script
Q: One of my pods throws errors reading “networkPlugin cni failed to set up pod ”< name >” network: add cmd: failed to assign an IP address to container”
A: Seems like the pod-per-node limit is reached: https://github.com/awslabs/amazon-eks-ami/blob/master/files/eni-max-pods.txt . Please report this as this as a bug here.
Still Have Questions?
Please reach out. We’re happy to answer them.