wmhilton/modserv

modserv

本项目是https://github.com/nolanlawson/local-npm%E7%9A%84%E5%88%86%E6%94%AF%EF%BC%8C%E7%9B%AE%E5%89%8Dlocal-npm%E5%B7%B2%E5%81%9C%E6%AD%A2%E7%BB%B4%E6%8A%A4%E3%80%82%E5%9C%A8modserv%E5%8F%91%E5%B8%831.0%E7%89%88%E6%9C%AC%E5%89%8D%EF%BC%8C%E5%BC%BA%E7%83%88%E5%BB%BA%E8%AE%AE%E4%BD%BF%E7%94%A8%E5%8E%9F%E7%89%88%E6%9C%AC%E3%80%82

镜像概述

modserv是一个Node.js服务器，作为本地npm registry镜像。它无需复制整个npm registry，可缓存模块并同步官方更新，让npm install在离线时（大部分）正常工作，且常用模块缓存越多，安装速度越快。

核心功能

• 代理缓存：首次安装从官方registry获取模块，后续直接从本地缓存读取；
• 实时同步：监听远程registry变化，模块元数据秒级同步；
• 离线支持：已缓存模块可无网络安装；
• 多人共享：团队/会议场景下共享镜像，减少重复下载；
• 浏览器UI：通过http://localhost:5080/_browse搜索查看模块。

使用场景

1. 开发团队内部搭建共享镜像，加速npm安装；
2. 网络不稳定或离线环境下确保npm正常使用；
3. 会议现场多人共用镜像，节省带宽；
4. 构建镜像链：指向其他modserv实例实现同步。

配置说明

Docker部署（推荐）

bash
docker run --detach --restart=always -p 80:80 --name my-registry --volume registry:/srv/data_volume wmhilton/modserv

• 配置文件和数据存储在registry持久卷，容器内路径/srv/data_volume；
• 查看卷挂载点：docker volume inspect registry，输出中Mountpoint为配置文件路径；
• 修改配置后重启容器：docker restart my-registry。

命令行选项

运行modserv支持以下参数：

• -h, --help：显示帮助；
• -p, --port：服务端口（默认5080）；
• -P, --pouch-port：pouchdb端口（默认***）；
• -r, --remote：远程fullfatdb地址（默认[***]
• -u, --url-base：客户端访问基础URL（默认[***]
• -d, --directory：数据存储目录（默认当前目录）。

进阶用法

• 镜像链同步：指向朋友的modserv实例：

  bash
  modserv --remote http://<朋友主机>:5080 --remote-skim http://<朋友主机>:16984/skimdb
  

• 多人共享：指定客户端访问URL：

  bash
  modserv --url-base [***]