Base Dev Container

Visual Studio Code的基础开发容器，基于Alpine和Debian系统，包含开发所需的核心工具和配置，主要用作其他开发镜像的基础镜像。

!标题图

镜像概述和主要用途

该镜像为Visual Studio Code提供基础开发环境，支持Alpine和Debian两种基础系统，适用于作为其他开发镜像的底层基础。它集成了开发过程中常用的工具、自定义终端环境和Docker相关组件，便于开发者在一致的环境中进行项目开发，并可轻松扩展以满足特定项目需求。

核心功能和特性

基础镜像选项

• qmcgaw/basedevcontainer:alpine（或:latest）：基于Alpine 3.22，镜像大小约230MB
• qmcgaw/basedevcontainer:debian：基于Debian Buster Slim，镜像大小约376MB

架构支持

所有镜像兼容amd64、386、arm64、armv7、armv6和ppc64le CPU架构。

包含的软件包

• libstdc++：VS Code服务器所需依赖
• zsh：替代/bin/sh的主shell
• git：Git仓库交互工具
• openssh-client：SSH密钥使用支持
• nano：终端文件编辑工具

包含的二进制工具

• gh：GitHub终端交互工具
• docker：Docker客户端
• docker-compose和docker compose Docker插件
• docker buildx Docker插件
• bit：命令行工具管理器
• devtainr：开发容器工具

自定义集成终端

• 基于zsh和oh-my-zsh
• 使用Powerlevel10k主题
• 集成Logo LS替代ls命令，登录时显示信息，易于扩展

其他特性

• 跨平台支持：可在Linux、macOS和Windows上绑定挂载SSH密钥，用于git操作
• Docker默认使用buildkit，配备最新Docker客户端
• 支持通过docker-compose.yml扩展配置
• 支持Linux、macOS和Windows系统的SSH密钥

要求

• 已安装并运行Docker
  • 若使用macOS，需在Docker Desktop中共享~/.ssh目录和项目目录
• 已安装Docker Compose
• 已安装VS Code
• 已安装VS Code Dev Containers扩展

项目设置

1. 下载本仓库并将.devcontainer目录放入项目中。或者，在项目路径中使用以下shell脚本：

   sh
   # 假设当前位于/yourpath/myproject
   mkdir .devcontainer
   cd .devcontainer
   wget -q [***]
   wget -q [***]
   

2. 若项目中有.vscode/settings.json，建议将设置移至.devcontainer/devcontainer.json的"settings"部分，因为.vscode/settings.json的设置会覆盖容器配置中的设置。

3. 在Visual Studio Code中打开命令面板（CTRL+SHIFT+P），选择Dev Containers: Open Folder in Container...，然后选择项目目录。

更多配置

devcontainer.json

• 可修改"postCreateCommand"以适应项目需求，例如组合多个命令：echo "downloading" && npm i
• 可在"extensions"数组中修改要安装的扩展
• 可在"settings"对象中添加或修改VS Code设置

docker-compose.yml

可添加其他容器与开发容器一起启动。例如添加PostgreSQL数据库：

1. 在.devcontainer/docker-compose.yml中添加以下配置块：

   yml
   database:
     image: postgres
     restart: always
     environment:
       POSTGRES_PASSWORD: password
   

2. 在Visual Studio Code中打开命令面板（CTRL+SHIFT+P）

3. 选择Dev-Containers: Rebuild Container

开发镜像构建与扩展

自行构建镜像

sh
docker build -t qmcgaw/basedevcontainer -f alpine.Dockerfile  [***]

扩展基础镜像

1. 创建.devcontainer/Dockerfile，以基础镜像为起点：FROM qmcgaw/basedevcontainer

2. 添加自定义指令，例如：

   • 安装Go包并添加别名：

     Dockerfile
     FROM qmcgaw/basedevcontainer
     COPY . .
     RUN echo "alias ls='ls -al'" >> ~/.zshrc
     

   • 安装Alpine软件包：

     Dockerfile
     FROM qmcgaw/basedevcontainer
     RUN apk add bind-tools
     

3. 修改.devcontainer/docker-compose.yml，在vscode服务中添加build: .

4. 在Visual Studio Code中打开命令面板（CTRL+SHIFT+P）

5. 选择Dev-Containers: Rebuild Container

自定义欢迎消息

可绑定挂载文件至/root/.welcome.sh以修改登录时显示的欢迎消息。

TODO

• bit complete 确认标志
• 防火墙配置，参见相关文档
• 扩展其他docker-compose.yml
• 为VS Code终端配置主机系统字体
• 添加GIF和图片示例
• 等待相关issue解决后，在镜像中预安装VS Code服务器和扩展