Merge pull request #481 from FabianKramm/main

feat: add forward ports & address option

cmd/up.go

@@ -4,9 +4,11 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"net"
 	"net/url"
 	"os"
 	"os/exec"
+	"strconv"
 
 	"github.com/loft-sh/devpod/cmd/flags"
 	"github.com/loft-sh/devpod/pkg/agent"
@@ -196,9 +198,32 @@ func startInBrowser(ctx context.Context, devPodConfig *config.Config, client cli
 	}
 
 	// determine port
-	vscodePort, err := port.FindAvailablePort(openvscode.DefaultVSCodePort)
-	if err != nil {
-		return err
+	var (
+		vscodeAddress string
+		vscodePort    int
+	)
+	if openvscode.Options.GetValue(ideOptions, openvscode.BindAddressOption) == "" {
+		vscodePort, err = port.FindAvailablePort(openvscode.DefaultVSCodePort)
+		if err != nil {
+			return err
+		}
+
+		vscodeAddress = fmt.Sprintf("%d", vscodePort)
+	} else {
+		vscodeAddress = openvscode.Options.GetValue(ideOptions, openvscode.BindAddressOption)
+		_, port, err := net.SplitHostPort(vscodeAddress)
+		if err != nil {
+			return fmt.Errorf("parse host:port: %w", err)
+		} else if port == "" {
+			return fmt.Errorf("parse ADDRESS: expected host:port, got %s", vscodeAddress)
+		}
+
+		vscodePort, err = strconv.Atoi(port)
+		if err != nil {
+			return fmt.Errorf("parse host:port: %w", err)
+		}
+
+		logger.Infof("Bind VSCode to %s...", vscodeAddress)
 	}
 
 	// wait until reachable then open browser
@@ -259,10 +284,10 @@ func startInBrowser(ctx context.Context, devPodConfig *config.Config, client cli
 				devPodConfig,
 				containerClient,
 				user,
+				openvscode.Options.GetValue(ideOptions, openvscode.ForwardPortsOption) == "true",
 				true,
 				true,
-				true,
-				[]string{fmt.Sprintf("%d:%d", vscodePort, openvscode.DefaultVSCodePort)},
+				[]string{fmt.Sprintf("%s:%d", vscodeAddress, openvscode.DefaultVSCodePort)},
 				logger,
 			)
 			if err != nil {

pkg/ide/openvscode/openvscode.go

@@ -25,17 +25,33 @@ const DownloadAmd64Template = "https://github.com/gitpod-io/openvscode-server/re
 const DownloadArm64Template = "https://github.com/gitpod-io/openvscode-server/releases/download/openvscode-server-%s/openvscode-server-%s-linux-arm64.tar.gz"
 
 const (
+	ForwardPortsOption  = "FORWARD_PORTS"
 	OpenOption          = "OPEN"
+	BindAddressOption   = "BIND_ADDRESS"
 	VersionOption       = "VERSION"
 	DownloadAmd64Option = "DOWNLOAD_AMD64"
 	DownloadArm64Option = "DOWNLOAD_ARM64"
 )
 
 var Options = ide.Options{
+	ForwardPortsOption: {
+		Name:        ForwardPortsOption,
+		Description: "If DevPod should automatically do port-forwarding",
+		Default:     "true",
+		Enum: []string{
+			"true",
+			"false",
+		},
+	},
+	BindAddressOption: {
+		Name:        BindAddressOption,
+		Description: "The address to bind VSCode web to locally. E.g. 0.0.0.0:12345",
+		Default:     "",
+	},
 	VersionOption: {
 		Name:        VersionOption,
 		Description: "The version for the open vscode binary",
-		Default:     "v1.78.2",
+		Default:     "v1.79.2",
 	},
 	OpenOption: {
 		Name:        OpenOption,

pkg/tunnel/services.go

@@ -15,6 +15,7 @@ import (
 	"github.com/loft-sh/devpod/pkg/config"
 	config2 "github.com/loft-sh/devpod/pkg/devcontainer/config"
 	"github.com/loft-sh/devpod/pkg/devcontainer/setup"
+	"github.com/loft-sh/devpod/pkg/ide/openvscode"
 	"github.com/loft-sh/devpod/pkg/netstat"
 	devssh "github.com/loft-sh/devpod/pkg/ssh"
 	"github.com/loft-sh/log"
@@ -28,7 +29,7 @@ func RunInContainer(
 	devPodConfig *config.Config,
 	containerClient *ssh.Client,
 	user string,
-	forwardPorts,
+	forwardPorts bool,
 	gitCredentials,
 	dockerCredentials bool,
 	extraPorts []string,
@@ -87,7 +88,7 @@ func RunInContainer(
 	// create a port forwarder
 	var forwarder netstat.Forwarder
 	if forwardPorts {
-		forwarder = newForwarder(containerClient, forwardedPorts, log)
+		forwarder = newForwarder(containerClient, append(forwardedPorts, fmt.Sprintf("%d", openvscode.DefaultVSCodePort)), log)
 	}
 
 	// forward credentials to container