DevPod Setup Guide

This guide provides comprehensive setup instructions for using DevPod with various providers, including local Docker, major cloud platforms, and manual setup for services like Rackspace.

Table of Contents

• Local Docker Setup
• DigitalOcean Setup
• AWS Setup
• GCP Setup
• Azure Setup

Local Docker Setup 🐳

The simplest setup option, perfect for getting started. Uses your local Docker installation.

Prerequisites

• Docker Desktop (or Docker Engine on Linux) installed and running

Setup Steps

1. Add the Provider (DevPod usually detects Docker automatically):

   devpod provider add docker

2. Create a Workspace:

   devpod up https://github.com/loft-sh/devpod-example-simple

DevPod will pull the necessary image and start a container on your local machine.

DigitalOcean Setup 💧

Create development workspaces on DigitalOcean Droplets.

Prerequisites

• DigitalOcean account
• doctl CLI installed and configured
• Personal Access Token (PAT) with read/write permissions

Setup Steps

1. Authenticate with doctl:

   doctl auth init --access-token YOUR_DIGITALOCEAN_TOKEN

2. Add the DigitalOcean Provider:

   devpod provider add digitalocean

3. Create a Workspace:

   devpod up https://github.com/your/repo --provider digitalocean

   Customize region and instance size:

   devpod up https://github.com/your/repo --provider digitalocean --option region=nyc3

AWS Setup 🌩️

Use Amazon EC2 instances for your workspaces with optional Spot Instance support for cost savings.

Prerequisites

• AWS account
• AWS CLI installed
• AWS credentials configured (aws configure or environment variables)

Setup Steps

1. Authenticate with AWS CLI:

   aws configure
   # Follow prompts: Access Key ID, Secret Access Key, region, output format

2. Add the AWS Provider:

   devpod provider add aws

3. Create a Workspace (Standard Instance):

   devpod up https://github.com/your/repo --provider aws

4. Create a Workspace (Spot Instance):

   devpod up https://github.com/your/repo --provider aws --option spot-instance=true

   Set maximum spot price:

   devpod up https://github.com/your/repo --provider aws --option spot-instance=true --option spot-price=0.03

GCP Setup ☁️

Provision workspaces on Google Compute Engine (GCE) virtual machines.

Prerequisites

• Google Cloud Platform account with project created
• gcloud CLI installed
• Billing enabled and Compute Engine API enabled for your project

Setup Steps

1. Authenticate with gcloud:

   gcloud auth application-default login
   gcloud config set project YOUR_PROJECT_ID

2. Add the GCP Provider:

   devpod provider add gcp

3. Create a Workspace:

   devpod up https://github.com/your/repo --provider gcp

   Customize zone and machine type:

   devpod up https://github.com/your/repo --provider gcp --option zone=us-central1-a --option machine-type=e2-medium

Azure Setup 🚀

Use Azure Virtual Machines for your development environments.

Prerequisites

• Azure account with active subscription
• Azure CLI (az) installed

Setup Steps

1. Authenticate with Azure CLI:

   az login
   # Follow browser-based login process

2. Set active subscription:

   az account set --subscription "YOUR_SUBSCRIPTION_NAME_OR_ID"

3. Add the Azure Provider:

   devpod provider add azure

4. Create a Workspace:

   devpod up https://github.com/your/repo --provider azure

   Specify location and VM size:

   devpod up https://github.com/your/repo --provider azure --option location=eastus --option vm-size=Standard_B2s