Remote-SSH

VS Code 使用 SSH 连接服务器

把编辑器留在本地,将文件、终端和运行环境放到远程 Ubuntu 服务器。

约 10 分钟Ubuntu ≥ 20.04Windows / macOS / Linux
不要在教程中公开真实密码

服务器 IP、用户名可以使用占位符;密码、私钥、Token 和完整 API Key 都不应出现在截图或示例文件中。

01前置条件

确认服务器系统与 SSH 可用

先在已有终端登录服务器并执行:

Ubuntu 服务器
cat /etc/os-release
ss -lnt | grep ':22'

服务器建议使用 Ubuntu 20.04 或更高版本。还需要准备服务器地址、SSH 端口、用户名,以及密码或私钥。

主机别名lab-server
服务器地址xxx.xxx.xxx.xxx
用户名your-user
SSH 端口22 或服务器实际端口
02本地准备

安装 Microsoft Remote - SSH

  1. 在本地 VS Code 中按 Ctrl + Shift + X
  2. 搜索 Remote - SSH
  3. 确认发布者为 Microsoft,然后安装。
  4. 安装完成后,点击左下角的远程状态按钮。
03主机配置

填写本地 .ssh/config

Windows 默认路径为 C:\Users\你的用户名\.ssh\config,macOS/Linux 默认路径为 ~/.ssh/config

SSH config
Host lab-server
  HostName xxx.xxx.xxx.xxx
  User your-user
  Port 22
  ServerAliveInterval 60

Host 是本地显示名称;HostName 才是服务器 IP 或域名。端口不是 22 时必须填写实际值。

04建立连接

从 VS Code 连接已保存主机

  1. 点击左下角远程状态按钮。
  2. 选择“连接到主机…”
  3. 选择 lab-server
  4. 首次连接时确认服务器系统为 Linux。
  5. 核对主机指纹并确认,然后输入 SSH 密码。
首次连接需要安装 VS Code Server

底部状态栏可能显示正在下载或安装服务端组件。等待完成,不要在此阶段重复点击连接。

05打开项目

选择服务器上的工作目录

  1. 连接完成后,在资源管理器点击“打开文件夹”
  2. 进入 /home/your-user
  3. 选择项目目录并确认。
  4. 打开 VS Code 终端,确认提示符显示远程用户名和主机名。
远程终端验收
hostname
pwd
whoami

此时左侧文件树、编辑器保存、集成终端和调试器都在操作服务器环境,而不是本地电脑。

06推荐增强

改用 SSH 密钥登录

密码登录验证成功后,建议在本地生成密钥并把公钥添加到服务器的 ~/.ssh/authorized_keys。Windows PowerShell 示例:

本地 Windows
ssh-keygen -t ed25519 -C "vscode-remote"
ssh-copy-id -p 22 your-user@xxx.xxx.xxx.xxx

如果 Windows 环境没有 ssh-copy-id,可以手动把本地 id_ed25519.pub 的单行内容追加到服务器的 ~/.ssh/authorized_keys

故障排查

连接超时或 Connection refused

检查服务器公网地址、端口、安全组/防火墙以及 SSH 服务状态。先在本地终端执行 ssh -vvv lab-server 获取详细日志。

反复要求输入密码

确认用户名和端口正确。使用密钥时,检查 IdentityFile 路径、服务器 authorized_keys 内容及权限。

VS Code Server 安装失败

检查服务器磁盘空间、网络访问、Shell 初始化脚本是否输出多余文本,以及用户目录是否可写。

远程打开后看不到本地插件

部分扩展需要在远程主机中单独安装。扩展页会显示“在 SSH: 主机名 中安装”,按需点击即可。

教程完成返回帮助中心