Visual Studio Code - 离线扩展库与更新服务

参见：[***]

该服务可镜像Visual Studio Code的网络资源，使其能在离线环境（如气隙环境）中无缝使用，或搭建私有扩展库。通过预期的接口提供内容服务，无需修改任何公开可用的二进制文件。通常，您只需同步所需内容到无互联网连接的系统，并将DNS指向镜像服务即可。不修改任何二进制文件或扩展。

特性

在有互联网连接的系统上，vscsync 会：

• 跨平台（Windows|Linux|Darwin）和版本（stable|insider）镜像VS Code安装程序/更新二进制文件；
• 从市场镜像推荐/典型扩展；
• 镜像***扩展列表；
• 镜像手动指定的扩展列表（artifacts/specified.json）；
• 可选地，镜像所有扩展（--syncall，而非默认的--sync）。

在无互联网连接的系统上，vscgallery 会：

• 实现更新器接口以支持离线更新；
• 实现扩展API以支持离线扩展使用；
• 实现***扩展列表；
• 初步支持多版本；
• 支持扩展搜索（名称、作者和简短描述）和排序；
• 支持自定义/私有扩展（遵循镜像扩展的结构）；
• 支持远程开发。

可能的待办事项：

• vscgallery - 支持分页（如果确实需要）；
• 研究某种依赖处理方式（如果可能）；
• 添加测试用例。

要求

• Docker（理想情况下使用docker-compose以简化操作）

入门 - 完整离线使用 - 使用Docker容器

包含两个组件：vscsync 在有互联网连接的系统上镜像内容，vscgallery 提供支持VS Code使用所需的API和端点。虽然设计用于离线环境，但通过一些DNS技巧，也可以将其作为"企业"VS Code扩展库运行。

在有互联网连接的系统上：

1. 获取/镜像Docker容器（vscsync/vscgallery）。

   docker-compose pull

2. 在有互联网连接的系统上设置并运行vscsync服务。

   • 确保工件目录可被用于传输机制和vscsync访问。
   • 运行vscsync服务并确保生成工件。
   • 等待同步完成。当工件下载完成时，您应该看到"Complete"并进入休眠状态。

   docker-compose up vscsync

3. 将工件复制到无互联网连接的系统。

在无互联网连接的系统上：

1. 在无互联网连接的系统上，确保以下DNS地址指向vscgallery服务。

   • update.code.visualstudio.com
   • az764295.vo.msecnd.net
   • marketplace.visualstudio.com

   这可以通过企业DNS服务器实现，或通过修改客户端的hosts文件。

2. 在您的环境中配置SSL/TLS以支持离线使用。

   • 要么创建为上述域签名并被客户端信任的证书；要么
   • 部署捆绑的根证书和中间证书颁发机构（vscoffline/vscgallery/ssl/ca.crt和ia.crt），但需注意明显的安全权衡。

   Windows 10：将证书导入计算机的受信任根证书颁发机构（开始 > "管理计算机证书"）。

   Darwin：将证书导入计算机的受信任根证书颁发机构。

   Ubuntu：最简单的方法似乎是打开Chrome，导航到chrome://settings/certificates，选择"授权机构"并添加证书。

3. 运行vscgallery服务，确保工件可被服务访问。它需要监听443端口。

   docker-compose up vscgallery

4. 使用Chrome导航到[***] Code可能无法正常工作。

5. 打开VS Code，希望您可以神奇地安装扩展和更新。帮助 > 开发者工具 > 网络应该会告诉您发生了什么。

注意：Chrome（而非其他浏览器）可能会给您更好的指示，因为VS Code和Chrome共享相同的证书信任。

入门 - 独立安装（测试或私有扩展库）- 使用Docker容器

本指南将在同一Docker主机上设置vscsync和vscgallery服务。

1. 获取docker-compose.yml文件。

   • 确保docker-compose DNS配置将覆盖步骤2中配置的内容（例如，vscsync可以访问互联网，而本地主机指向vscgallery服务）。
   • 确保两个容器将挂载相同的工件文件夹。

2. 将DNS地址指向vscgallery服务。

   • update.code.visualstudio.com
   • az764295.vo.msecnd.net
   • marketplace.visualstudio.com

   这可以通过企业DNS服务器实现，或通过修改客户端的hosts文件。

3. 按上述说明部署必要的SSL/TLS证书。

4. 运行服务

   docker-compose up

5. 使用Chrome导航到[***] Code可能无法正常工作。

6. 打开VS Code，希望您可以神奇地安装扩展和更新。帮助 > 开发者工具 > 网络应该会告诉您发生了什么。

同步参数（vscsync）

这些参数可以作为命令行参数传递给sync.py（例如--varA或--varB），或通过Docker环境变量SYNCARGS传递。

典型同步参数：

• --sync 获取稳定版二进制文件和流行扩展。
• --syncall 获取所有内容（稳定版二进制文件、insider版二进制文件和所有扩展）。
• --sync --check-insider 获取稳定版二进制文件、insider版二进制文件和流行扩展。

可能的参数：

usage: sync.py [-h] [--sync] [--syncall] [--artifacts ARTIFACTDIR]
               [--frequency FREQUENCY] [--check-binaries] [--check-insider]
               [--check-recommended-extensions] [--check-specified-extensions]
               [--extension-name EXTENSIONNAME]
               [--extension-search EXTENSIONSEARCH] [--update-binaries]
               [--update-extensions] [--update-malicious-extensions]
               [--prerelease-extensions] [--vscode-version VSCODEVERSION]
               [--skip-binaries] [--debug] [--logfile LOGFILE]

Synchronises VSCode in an Offline Environment

optional arguments:
  -h, --help            show this help message and exit
  --sync                基本用户同步。包括稳定版二进制文件和典型扩展
  --syncall             高级用户同步。包括所有二进制文件和扩展
  --artifacts ARTIFACTDIR
                        下载工件的路径
  --frequency FREQUENCY
                        尝试更新的频率（例如，休眠'12h'后重试）
  --total-recommended N 
                        要获取的推荐扩展数量（默认：200）
  --check-binaries      检查更新的二进制文件
  --check-insider       检查更新的insider二进制文件
  --check-recommended-extensions
                        检查推荐扩展
  --check-specified-extensions
                        检查<artifacts>/specified.json中的扩展
  --extension-name EXTENSIONNAME
                        按名称查找特定扩展
  --extension-search EXTENSIONSEARCH
                        搜索一组扩展
  --update-binaries     下载二进制文件
  --update-extensions   下载扩展
  --update-malicious-extensions
                        更新***扩展列表
  --prerelease-extensions
                        下载预发布扩展。默认为false。
  --vscode-version
                        用于搜索扩展的VSCode版本。
  --skip-binaries       跳过下载二进制文件
  --debug               显示调试输出
  --logfile LOGFILE     设置存储日志输出的日志文件