bufferoverflow/verdaccio-gitlab

Verdaccio-GitLab镜像

镜像概述

该镜像将Verdaccio（Sinopia的分支）私有npm仓库与GitLab社区版集成，以GitLab作为认证和授权提供者，实现基于GitLab用户权限的npm包访问与发布管理，无需管理员令牌即可运行。

核心功能

1. GitLab认证：用户通过GitLab个人访问令牌完成身份验证
2. 权限控制：根据用户在GitLab项目/组中的权限，控制npm包的访问与发布
3. 认证缓存：支持内存缓存认证信息，可配置TTL以减少GitLab服务器请求
4. 灵活配置：可自定义GitLab服务器地址、缓存策略及发布所需的最小权限等级

使用场景

• 企业内部私有npm包的统一管理与分发
• 团队协作开发中，基于GitLab权限的包访问控制
• 需要与GitLab生态集成的npm仓库场景

配置说明

基础配置示例

在Verdaccio配置文件（如~/.config/verdaccio/config.yaml）中添加以下内容：

yaml
auth:
  gitlab:
    url: https://gitlab.com # GitLab服务器地址（必填）
    authCache:
      enabled: true # 启用认证缓存
      ttl: 300 # 缓存有效期（秒）
    publish: $maintainer # 发布所需最小权限（可选值：$guest/$reporter/$developer/$maintainer/$owner）

packages:
  '@*/*':
    access: $all
    publish: $maintainer
    proxy: npmjs
    gitlab: true # 启用GitLab权限控制

  '**':
    access: $all
    publish: $maintainer
    proxy: npmjs
    gitlab: true

配置选项说明

Docker部署示例

1. 克隆仓库并构建镜像：

sh
git clone https://github.com/bufferoverflow/verdaccio-gitlab.git
cd verdaccio-gitlab
docker-compose up --build -d

2. 访问GitLab（http://localhost:50080），使用默认账号`root`/`verdaccio`登录
3. 创建GitLab个人访问令牌（路径：Profile → Personal Access Tokens）
4. 访问npm仓库（http://localhost:4873），使用GitLab用户名和令牌登录
5. 通过命令行发布包：

sh
yarn publish --registry http://localhost:4873

自定义配置

若需覆盖默认配置，可将自定义config.yaml文件挂载到容器的/verdaccio/conf/config.yaml路径：

sh
docker run -v /path/to/your/config.yaml:/verdaccio/conf/config.yaml bufferoverflow/verdaccio-gitlab