steedos/verdaccio

steedos/verdaccio 镜像文档

镜像概述

steedos/verdaccio是一个基于Verdaccio的Docker镜像，专门用于搭建私有npm仓库。该镜像集成了Steedos认证机制，支持通过Steedos用户系统进行权限控制，并提供AWS S3存储集成，可将npm包存储至AWS S3云存储服务。通过简单配置即可快速部署，满足企业内部私有npm包的管理需求。

核心功能与特性

• Steedos认证集成：通过Steedos用户系统实现访问和发布权限控制，支持基于用户组的权限管理
• AWS S3存储支持：可将npm包存储至AWS S3，支持自定义存储桶、区域及访问密钥配置
• 灵活配置：通过config.yaml文件自定义仓库行为，包括包访问权限、日志配置、请求大小限制等
• 环境变量管理：通过local.env文件配置敏感信息，如Steedos服务地址、AWS S3凭证等
• 容器化部署：提供完整的docker-compose配置，支持快速部署和启停

使用场景

• 企业内部私有npm包管理，需严格控制包的访问和发布权限
• 需要将npm包存储至云存储服务（如AWS S3）的场景
• 希望通过容器化方式快速搭建和维护私有npm仓库的团队

使用方法

1. 准备工作

设置映射文件夹权限

bash
# 配置文件夹权限
sudo chmod -R 777 ./config

# 本地存储文件夹权限（如使用本地存储而非S3时）
sudo chmod -R 777 ./storage

2. 配置文件准备

调整 config.yaml

在./config目录下创建或修改config.yaml文件，配置仓库行为：

yaml
plugins: /verdaccio/plugins
storage: /verdaccio/storage  # 本地存储路径，使用S3时仍需配置但实际存储在S3
auth:
  steedos:
    steedos_user_key: mobile  # Steedos用户标识字段
    request_timeout_ms: 1000  # 认证请求超时时间（毫秒）
    cache_ttl_ms: 60000       # 认证缓存有效期（毫秒）
packages:
  '@*/*':                     # 作用于@开头的作用域包
    access: $steedos_group    # 访问权限：Steedos用户组
    publish: $steedos_group   # 发布权限：Steedos用户组
  '**':                       # 作用于所有其他包
    access:                   # 默认为空，即无访问权限
    publish:                  # 默认为空，即无发布权限
logs:
  - {type: stdout, format: pretty, level: http}  # 日志配置：标准输出、美化格式、http级别
max_body_size: 20mb  # 最大请求体大小限制
security:
  api:
    legacy: false
    jwt:
      sign:
        expiresIn: 365d  # API JWT令牌有效期
  web:
    sign:
      expiresIn: 7d      # Web界面JWT令牌有效期
store:
  aws-s3-storage:        # AWS S3存储配置
    bucket: STEEDOS_PACKAGES_AWS_S3_BUCKET           # 存储桶名称（从环境变量获取）
    region: STEEDOS_PACKAGES_AWS_S3_REGION           # 区域（从环境变量获取）
    endpoint: STEEDOS_PACKAGES_AWS_S3_ENDPOINT       # 自定义端点（可选，从环境变量获取）
    s3ForcePathStyle: false                          # 是否强制路径样式访问
    accessKeyId: STEEDOS_PACKAGES_AWS_S3_ACCESS_KEY_ID     # 访问密钥ID（从环境变量获取）
    secretAccessKey: STEEDOS_PACKAGES_AWS_S3_SECRET_ACCESS_KEY  # 密钥（从环境变量获取）

配置环境变量

拷贝环境变量模板文件为local.env并配置实际值：

env
# Steedos服务根地址，用于认证
STEEDOS_SERVER_ROOT_URL=https://console.dev.steedos.com

# AWS S3存储配置（使用S3时必填）
STEEDOS_PACKAGES_AWS_S3_REGION=
STEEDOS_PACKAGES_AWS_S3_BUCKET=
STEEDOS_PACKAGES_AWS_S3_ACCESS_KEY_ID=
STEEDOS_PACKAGES_AWS_S3_SECRET_ACCESS_KEY=
STEEDOS_PACKAGES_AWS_S3_ENDPOINT=  # 可选，如使用S3兼容存储（如MinIO）需配置

3. 启动服务

使用docker-compose启动服务：

yaml
# docker-compose.yml
services:
  verdaccio:
    image: steedos/verdaccio:1.x  # 镜像名称及版本
    container_name: "steedos-verdaccio"  # 容器名称
    networks:
      - node-network  # 网络配置
    env_file: 
      - ./local.env  # 环境变量文件路径
    environment:
      - VERDACCIO_PORT=4873  # 服务端口
    ports:
      - "4873:4873"  # 端口映射：宿主机端口:容器端口
    volumes:
      - "./config:/verdaccio/conf"  # 配置文件夹挂载
networks:
  node-network:
    driver: bridge  # 网络驱动类型

启动命令：

bash
docker-compose up -d

配置说明

config.yaml 核心配置项

• auth.steedos：Steedos认证配置，控制用户验证逻辑
  • steedos_user_key：用于标识用户的字段（如mobile、email）
  • request_timeout_ms：认证请求超时时间
  • cache_ttl_ms：认证结果缓存时间
• packages：包权限配置，支持按包名模式设置访问和发布权限
• security：安全配置，包括JWT令牌有效期
• store.aws-s3-storage：AWS S3存储配置，所有值通过环境变量注入，避免硬编码敏感信息

local.env 环境变量说明

• STEEDOS_SERVER_ROOT_URL：Steedos服务地址，用于用户认证
• AWS S3相关变量：仅在使用S3存储时需要配置，需提供有效的AWS访问凭证和存储桶信息

访问服务

服务启动后，可通过http://<宿主机IP>:4873访问私有npm仓库Web界面，或通过npm客户端配置 registry 地址使用：

bash
npm set registry http://<宿主机IP>:4873