defra-docker-node 镜像文档

镜像概述

defra-docker-node 是一个Node.js开发父镜像，由DEFRA（英国环境、食品和农村事务部）维护，旨在为Node.js应用开发提供统一的基础开发环境。该镜像集成了标准化的Node.js运行时、开发工具链及配置模板，可作为各类Node.js项目的基础镜像，确保跨项目开发环境一致性，减少重复配置工作。

核心功能与特性

标准化运行环境

• 基于***Node.js镜像构建，提供稳定的Node.js版本（具体版本可通过标签指定，如18-alpine、20-buster等）
• 预配置npm/yarn包管理器，支持依赖安装与版本锁定

开发工具集成

• 内置代码质量工具：ESLint（含预设规则）、Prettier（代码格式化）
• 集成构建工具：Webpack、Babel（可选，根据标签版本）
• 包含Git、curl等基础系统工具，满足开发流程需求

配置标准化

• 提供预设配置文件（.eslintrc.js、.prettierrc、.gitignore等），支持跨项目配置复用
• 统一的用户权限与目录结构（如/app作为工作目录），避免权限问题

可扩展性

• 支持通过环境变量自定义配置（如镜像源、代理设置）
• 设计为父镜像，允许子镜像通过FROM指令扩展功能

使用场景

• 作为DEFRA内部Node.js项目的基础开发镜像
• 构建Node.js微服务、API后端或前端应用的开发环境
• 需要确保多团队协作时开发环境一致性的场景
• 简化新项目初始化流程，减少重复配置工作

使用方法

1. 获取镜像

通过Docker Hub或私有 registry 拉取镜像（具体地址需参考项目文档）：

bash
docker pull defra/defra-docker-node:latest  # 最新稳定版
# 或指定Node.js版本
docker pull defra/defra-docker-node:20-alpine

2. 作为父镜像使用

在项目Dockerfile中以该镜像为基础构建子镜像：

dockerfile
# 从defra-docker-node继承基础环境
FROM defra/defra-docker-node:20-alpine

# 设置工作目录（继承自父镜像，默认/app）
WORKDIR /app

# 复制项目依赖文件并安装依赖
COPY package.json package-lock.json ./
RUN npm ci  # 使用package-lock.json安装精确依赖

# 复制项目源代码
COPY . .

# 覆盖默认启动命令（根据项目需求调整）
CMD ["npm", "run", "dev"]

3. 环境变量配置

支持通过环境变量自定义行为，常用变量如下：

示例：通过环境变量修改npm镜像源

dockerfile
FROM defra/defra-docker-node:20-alpine
ENV NPM_REGISTRY=[***]
RUN npm config set registry $NPM_REGISTRY

4. docker-compose集成

在docker-compose.yml中使用该镜像配置开发环境：

yaml
version: '3.8'
services:
  app:
    build:
      context: .
      dockerfile: Dockerfile
    image: defra/defra-docker-node:20-alpine
    environment:
      - NODE_ENV=development
      - NPM_REGISTRY=[***]
    volumes:
      - ./:/app  # 挂载本地代码，支持热重载
      - node_modules:/app/node_modules  # 持久化依赖目录
    ports:
      - "3000:3000"  # 映射应用端口

volumes:
  node_modules:  # 定义***卷，避免本地依赖覆盖

5. 自定义配置扩展

如需覆盖父镜像默认配置（如ESLint规则），可在子项目中添加自定义配置文件，子镜像构建时会自动覆盖：

bash
# 项目根目录添加自定义.eslintrc.js
echo "module.exports = { extends: ['defra', 'prettier'] }" > .eslintrc.js

注意事项

• 生产环境建议使用特定版本标签（如20-alpine）而非latest，确保版本稳定性
• 子镜像构建时如需修改系统依赖，需使用root用户执行（可通过USER root切换）
• 本地开发时通过volumes挂载代码可实现热重载，但需注意文件权限与容器内用户匹配