sdpequinor/verdaccio-github-auth

sdpequinor/verdaccio-github-auth镜像说明

镜像概述

本镜像基于官方verdaccio/verdaccio镜像构建，集成了verdaccio-github-oauth-ui和sinopia-github-oauth插件，支持通过GitHub OAuth协议进行用户身份认证，帮助企业或团队快速搭建具备GitHub账号登录能力的私有npm仓库。

核心功能

1. 提供GitHub OAuth登录界面，简化用户认证流程
2. 支持通过GitHub账号验证用户身份，实现统一权限管理
3. 继承Verdaccio的私有npm仓库核心功能（包发布、安装、版本管理等）

使用场景

• 企业内部搭建私有npm仓库，需要通过GitHub账号统一管理团队成员访问权限
• 开源项目团队使用GitHub作为身份源，搭建专属的npm包管理平台

配置说明

需在Verdaccio配置文件（config.yaml）中添加以下GitHub OAuth相关配置：

yaml
auth:
  github-oauth:
    client-id: YOUR_GITHUB_CLIENT_ID
    client-secret: YOUR_GITHUB_CLIENT_SECRET
    org: YOUR_GITHUB_ORG # 可选，限制仅特定组织成员访问
    team: YOUR_GITHUB_TEAM # 可选，限制仅特定团队成员访问
  github-oauth-ui:
    enabled: true
    client-id: YOUR_GITHUB_CLIENT_ID
    client-secret: YOUR_GITHUB_CLIENT_SECRET
    callback-url: http://your-verdaccio-domain.com/callback

部署示例

Docker Run命令

bash
docker run -d \
  --name verdaccio-github-auth \
  -p 4873:4873 \
  -v /local/path/to/config:/verdaccio/conf \
  -v /local/path/to/storage:/verdaccio/storage \
  sdpequinor/verdaccio-github-auth

Docker Compose示例

yaml
version: '3'
services:
  verdaccio:
    image: sdpequinor/verdaccio-github-auth
    ports:
      - "4873:4873"
    volumes:
      - ./config:/verdaccio/conf
      - ./storage:/verdaccio/storage
    restart: always