ahmadnassri/vscode-server

VS Code Server Docker 镜像文档

1. 镜像概述和主要用途

Visual Studio Code Server 是一种可在远程开发机器（如台式机或虚拟机）上运行的服务，允许从任何地方通过 vscode.dev URL 安全连接该远程机器，无需依赖 SSH。本 Docker 镜像是 VS Code Server 的容器化版本，旨在简化其部署流程，提供标准化的运行环境，方便用户快速搭建和使用远程开发服务。

2. 核心功能和特性

• 完全本地运行：无需依赖 vscode.dev 在线服务，可在本地环境独立运行
• 持久化密钥管理：支持密钥持久化存储，满足设置同步（Settings Sync）功能的运行要求

3. 使用场景和适用范围

• 远程开发环境搭建：在服务器或虚拟机上部署，作为集中式开发环境，供个人或团队远程访问
• 多设备开发配置同步：通过持久化用户数据和密钥，实现不同设备间开发配置（如编辑器设置、快捷键、扩展）的同步
• 无需 SSH 的远程访问：替代传统 SSH 连接方式，通过 Web 界面直接访问远程开发环境，降低网络配置复杂度

4. 使用方法和配置说明

4.1 基本使用（docker run 命令）

通过以下命令快速启动 VS Code Server 容器：

bash
docker run --rm \
  --name vscode-server \
  --hostname vscode \
  -p 8000:8000 \
  -v ./server-data:/root/.vscode/server-data \
  -v ./user-data:/root/.vscode/user-data \
  -v ./cli-data:/root/.vscode/cli-data \
  -v ./extensions:/root/.vscode/extensions \
  ahmadnassri/vscode-server:latest

参数说明：

• --rm：容器停止后自动删除容器文件
• --name vscode-server：指定容器名称为 vscode-server
• --hostname vscode：设置容器主机名为 vscode
• -p 8000:8000：端口映射，将容器内 8000 端口映射到主机 8000 端口（用于 Web 访问）
• 卷挂载（-v）：
  • ./server-data:/root/.vscode/server-data：持久化服务器运行时数据
  • ./user-data:/root/.vscode/user-data：持久化用户配置（如设置、快捷键等）
  • ./cli-data:/root/.vscode/cli-data：持久化命令行工具相关数据
  • ./extensions:/root/.vscode/extensions：持久化已安装的 VS Code 扩展

4.2 Docker Compose 配置

创建 docker-compose.yml 文件，通过 Docker Compose 管理容器：

yaml
version: '3.8'

services:
  vscode-server:
    image: ahmadnassri/vscode-server:latest
    container_name: vscode-server
    hostname: vscode
    ports:
      - "8000:8000"
    volumes:
      - ./server-data:/root/.vscode/server-data
      - ./user-data:/root/.vscode/user-data
      - ./cli-data:/root/.vscode/cli-data
      - ./extensions:/root/.vscode/extensions
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动命令：

bash
docker-compose up -d

4.3 卷挂载说明

卷挂载是确保数据持久化的关键，以下是各挂载目录的详细说明：

注意：首次运行前需确保主机目录已创建，避免权限问题可提前执行 mkdir -p server-data user-data cli-data extensions。