Skip to content

[Note: Not needed with VS Code anymore.] Forwards the host's ssh-agent into a Docker container on Windows and macOS hosts.

License

Notifications You must be signed in to change notification settings

ensody/ssh-agent-inject

Repository files navigation

ssh-agent-inject

Forwards the host's ssh-agent into a Docker container. This is especially useful when working with the Visual Studio Code Remote - Containers extension and Git repos cloned via SSH.

Why this is needed

While you can bind-mount the SSH_AUTH_SOCK from a Linux host, this is not possible from a macOS or Windows host. Also, none of the existing solutions is cross-platform and easy. The recommended solution is to copy the SSH key from the host to the container, but then you have to manually add the key (assuming you've setup ssh-agent within the container) and enter the password within the container.

With ssh-agent-inject you can skip those annoyances and simply reuse your host's ssh-agent.

Usage

Add ENV SSH_AUTH_SOCK=/tmp/.ssh-auth-sock to your Dockerfile and label your container with com.ensody.ssh-agent-inject (docker run -l com.ensody.ssh-agent-inject ...).

Download ssh-agent-inject for your platform. Make sure ssh-agent-inject runs in the background or just launch it on-demand.

Note that this project is itself using ssh-agent-inject with VS Code (see .devcontainer/).

Building

All required dependencies are contained in a Docker image defined in .devcontainer/, which can be automatically used with Visual Studio Code (or manually via Docker build & run). That way your host system stays clean and the whole environment is automated, exactly defined, isolated from the host, and easily reproducible. This saves time and prevents mistakes (wrong version, interference with other software installed on host, etc.).

Use goreleaser to build binaries for all platforms:

goreleaser --snapshot --skip-publish --rm-dist