OpenVSCode Server 镜像文档

1. 镜像概述和主要用途

OpenVSCode Server 是一个基于 Visual Studio Code (VS Code) 架构的服务器应用，旨在在远程机器上运行，并允许通过现代 Web 浏览器进行访问。它采用与 Gitpod 或 GitHub Codespaces 相同的底层架构，提供了无需安装桌面客户端即可使用 VS Code 核心功能的远程开发环境。

2. 核心功能和特性

远程浏览器访问：支持通过现代 Web 浏览器直接访问远程服务器上的 VS Code 实例，打破设备限制。
原生架构兼容：基于 2019 年 VS Code 团队重构的远程运行架构，避免早期复杂且易错的补丁方案。
最小化修改：仅添加运行 Web 服务器所需的必要代码变更，保持与上游 VS Code 的高度兼容性。
低维护成本：可直接依赖最新版 VS Code，升级路径清晰，大幅降低维护复杂度。

3. 使用场景和适用范围

3.1 适用场景

远程开发环境：开发者通过浏览器从任意设备访问远程服务器上的开发环境，实现跨设备开发。
共享协作环境：团队共享统一的远程开发环境，确保环境一致性，简化协作流程。
轻量级访问需求：在无法安装桌面软件的设备（如低配置设备、公共设备）上，通过浏览器使用 VS Code。

3.2 项目范围

本项目仅专注于添加运行 Web 服务器所需的最小化修改，不改变 VS Code 核心功能，也不通过此项目新增特性。所有非 Web 服务器运行场景相关的功能请求、Bug 修复或贡献，均需提交至上游 VS Code 仓库：Visual Studio Code - Open Source "OSS"。

4. 使用方法和配置说明

4.1 Docker 快速部署

通过 Docker 容器可快速启动 OpenVSCode Server，命令如下：

bash
docker run -it --init -p 3000:3000 -v "$(pwd):/home/workspace:cached" gitpod/openvscode-server

参数说明：

-it：以交互式终端模式运行容器，支持实时输入输出。
--init：使用 init 进程管理容器内进程，确保信号正确传递和进程优雅退出。
-p 3000:3000：端口映射，将主机 3000 端口映射到容器 3000 端口（容器内服务默认监听 3000 端口）。
-v "$(pwd):/home/workspace:cached"：挂载主机当前目录到容器内的 /home/workspace 目录，cached 模式可提升本地文件系统访问性能（适用于开发目录共享）。
gitpod/openvscode-server：Docker 镜像名称。