与容器共享 Git 凭据
Dev Containers 扩展开箱即用地支持在容器内使用本地 Git 凭据。在本节中,我们将介绍两种受支持的选项。
如果未在本地设置用户名或电子邮件地址,可能会提示您进行设置。您可以通过在本地计算机上运行以下命令来执行此操作
git config --global user.name "Your Name"
git config --global user.email "your.email@address"
扩展将在启动时自动将您的本地 .gitconfig
文件复制到容器中,因此您无需在容器本身中执行此操作。
使用凭据帮助程序
如果您使用 HTTPS 克隆存储库并在本地操作系统中配置了凭据帮助程序,则无需进行进一步设置。 您在本地输入的凭据将在容器中重复使用,反之亦然。
使用 SSH 密钥
在某些情况下,您可能使用 SSH 密钥而不是凭据帮助程序来克隆存储库。要启用此方案,如果本地 SSH 代理正在运行,扩展将自动转发它。
首先,您应确保在主机上启用了SSH 代理转发。在 sshd_config(通常位于 /etc/ssh/sshd_config
或 %programdata%\ssh\sshd_config
)中查找 AllowAgentForwarding
选项。如果尚未设置,则应将其设置为 yes
并重新加载或重启 sshd
服务。
如果 SSH 代理正在运行,您可以使用 ssh-add
命令将本地 SSH 密钥添加到代理中。例如,从终端或 PowerShell 运行此命令
ssh-add
它将添加默认文件(~/.ssh/id_rsa
、.ssh/id_dsa
、~/.ssh/id_ecdsa
、~/.ssh/id_ed25519
和 ~/.ssh/identity
)。如果您想指定密钥,只需在命令后追加其路径即可。
在 Windows 和 Linux 上,您可能会因为代理未运行而遇到错误(macOS 通常默认运行代理)。按照以下步骤解决此问题
Windows:
启动本地管理员 PowerShell 并运行以下命令
# Make sure you're running as an Administrator
Set-Service ssh-agent -StartupType Automatic
Start-Service ssh-agent
Get-Service ssh-agent
Linux
首先,在终端中运行以下命令在后台启动 SSH 代理
eval "$(ssh-agent -s)"
然后将这些行添加到您的 ~/.bash_profile
或 ~/.zprofile
(对于 Zsh),使其在登录时启动
if [ -z "$SSH_AUTH_SOCK" ]; then
# Check for a currently running instance of the agent
RUNNING_AGENT="`ps -ax | grep 'ssh-agent -s' | grep -v grep | wc -l | tr -d '[:space:]'`"
if [ "$RUNNING_AGENT" = "0" ]; then
# Launch a new instance of the agent
ssh-agent -s &> $HOME/.ssh/ssh-agent
fi
eval `cat $HOME/.ssh/ssh-agent` > /dev/null
ssh-add 2> /dev/null
fi
在最后一行,将 <your ssh key>
替换为您的特定 ssh 密钥。
例如 ssh-add $HOME/.ssh/id_ed25519 2> /dev/null
如果遇到任何问题,您可能需要查看 Dev Containers 扩展的已知限制。
共享 GPG 密钥
如果您想使用 GPG 签署您的提交,您也可以与容器共享本地密钥。您可以在GitHub 的文档中找到关于使用 GPG 密钥进行签名的方法。
如果您尚未设置 GPG,可以为您的平台进行配置
- 在 Windows 上,您可以安装 Gpg4win。
- 在 macOS 上,您可以安装 GPG Tools。
- 在 Linux 上,使用您的系统包管理器在本地安装
gnupg2
包。 - 在 WSL 上
- 在 Windows 端安装 Gpg4win。
- 在 WSL 发行版中安装
gpg
。运行sudo apt install gpg
- 在 WSL 发行版中注册
pinentry
GUI。运行echo pinentry-program /mnt/c/Program\ Files\ \(x86\)/Gpg4win/bin/pinentry.exe > ~/.gnupg/gpg-agent.conf
- 在 WSL 中重新加载
gpg
代理。运行gpg-connect-agent reloadagent /bye
注意:对于 Windows 用户,GPG 签名密钥必须使用 Windows GUI 或 CLI (powershell/cmd) 进行配置,而不能在 Git Bash 中配置。Dev Container 无法访问在 Git Bash 中设置的 GPG 密钥,即使它位于您可通过 Windows 资源管理器访问的
~/.gnupg/
文件夹中。
接下来,通过更新 Dockerfile 在容器中安装 gnupg2
。
例如
RUN apt-get update && apt-get install gnupg2 -y
或者如果以非 root 用户身份运行
RUN sudo apt-get update && sudo apt-get install gnupg2 -y
要应用配置更改,需要重新生成容器。您可以通过从命令面板 (F1
) 运行开发容器: 重建容器来执行此操作。下次容器启动时,您的 GPG 密钥也应该可以在容器内部访问。
注意:如果您之前在容器中使用过
gpg
,可能需要运行开发容器: 重建容器以使更新生效。