乐趣区

npm私库搭建-基于cnpm-mysql

summary

搭私库
  1. 下载 cnpm 并安装依赖
  2. 创建数据库并导入数据库
  3. 修改 cnpmjs.org/config/index.js 配置文件
  4. 启动 cnpm 服务器
使用
  1. 添加管理员或 npm login
  2. 配置 cnpm 的 registry(注册表、挂号处)指向私库地址
  3. 发布包

steps

下载 cnpm 并安装依赖
git clone git://github.com/cnpm/cnpmjs.org
cd cnpmjs.org
npm install

install 如果报错 Error: EACCES: permission denied, access '/usr/local/cnpmjs.org', 可尝试修改该目录下权限,修改权限后可以不用 sudo 就能修改文件:

chmod -R 777 < 目录 > # -R 为递归删除 用于多目录 777 为所有权限
npm install # 重新 install
创建数据库并导入数据库
mysql -u < 用户名 > -p
show databases; # 查看有哪些数据库
CREATE DATABASE library; # 若没有新建一个
mysql>use < 数据库名 >;
mysql>source <sql 后缀文件所在路径 >
mysql>show tables; # 查看导入的所有表
修改 cnpm 项目的配置文件
//config.js:module.exports = {

    debug: false,
    bindingHost: '0.0.0.0', // 设定只能用该 IP 访问
    cnpm 服务器
    scopes: ['@sunrun'],// 指定你的私有包的前缀,你发布的包必须以此开头
    enableCluster: true, // enable cluster mode
    sourceNpmRegistry: 'https://registry.npm.taobao.org',

    database: {
          db:'cnpmjs',         // 数据库名
          host: '192.168.8.200',    // 你的数据库地址
          port:3306,           // 默认
          username:'admin',     // 默认
          password:'sunrun',  // 默认为空
          dialect:'mysql'      // 使用 mysql,默认为 sqlite,
  },

    enablePrivate:true, // 开启私有库

    admins: {admin: 'zxy@gz.sunrun.com',},
    syncModel: 'none'
    // 默认有 none,exist,all,此处设置为 none,即不同步 npm 源已有的库至本地,// 如果设置为 exist,则会同步线上 npm 源存在的模块
    // 比如当你执行安装某线上模块时,则会把线上该模块版本全部同步至本地库

 }
下面列出一些常用的配置说明
  • enableCluster:是否启用 cluster-worker 模式启动服务,默认 false,生产环节推荐为 true;
  • registryPort:API 专用的 registry 服务端口,默认 7001;
  • webPort:Web 服务端口,默认 7002;
  • bindingHost:监听绑定的 Host,默认为 127.0.0.1,如果外面架了一层本地的 Nginx 反向代理或者 Apache 反向代理的话推荐不用改;
  • sessionSecret:session 用的盐;
  • logdir:日志目录;
  • uploadDir:临时上传文件目录;
  • viewCache:视图模板缓存是否开启,默认为 false;
  • enableCompress:是否开启 gzip 压缩,默认为 false;
  • admins:管理员们,这是一个 JSON Object,对应各键名为各管理员的用户名,键值为其邮箱,默认为 {fengmk2: ‘fengmk2@gmail.com’, admin: ‘admin@cnpmjs.org’, dead_horse: ‘dead_horse@qq.com’};
  • logoURL:Logo 地址,不过对于我这个已经把 CNPM 前端改得面目全非的人来说已经忽略了这个配置了;
  • adBanner:广告 Banner 的地址;
  • customReadmeFile:实际上我们看到的 cnpmjs.org 首页中间一大堆冗长的介绍是一个 Markdown 文件转化而成的,你可以设置该项来自行替换这个文件;
  • customFooter:自定义页脚模板;
  • npmClientName:默认为 cnpm,如果你有自己开发或者 fork 的 npm 客户端的话请改成自己的 CLI 命令,这个应该会在一些页面的说明处替换成你所写的;
  • backupFilePrefix:备份目录;
  • database:数据库相关配置,为一个对象,默认如果不配置将会是一个 ~/.cnpmjs.org/data.sqlite 的 SQLite;
  • db:数据的库名;
  • username:数据库用户名;
  • password:数据库密码;
  • dialect:数据库适配器,可选 “mysql”、”sqlite”、”postgres”、”mariadb”,默认为 “sqlite”;
  • hsot:数据库地址;
  • port:数据库端口;
  • pool:数据库连接池相关配置,为一个对象;
  • maxConnections:最大连接数,默认为 10;
  • minConnections:最小连接数,默认为 0;
  • maxIdleTime:单条链接最大空闲时间,默认为 30000 毫秒;
  • storege:仅对 SQLite 配置有效,数据库地址,默认为 ~/.cnpmjs/data.sqlite;
  • nfs:包文件系统处理对象,为一个 Node.js 对象,默认是 fs-cnpm 这个包,并且配置在 ~/.cnpmjs/nfs 目录下,也就是说默认所有同步的包都会被放在这个目录下;开发者可以使用别的一些文件系统插件(如上传到又拍云等), 又或者自己去按接口开发一个逻辑层,这些都是后话了;
  • registryHost:暂时还未试过,我猜是用于 Web 页面显示用的,默认为 r.cnpmjs.org;
  • enablePrivate:是否开启私有模式,默认为 false;
  • 如果是私有模式则只有管理员能发布包,其它人只能从源站同步包;
  • 如果是非私有模式则所有登录用户都能发布包;
  • scopes:非管理员发布包的时候只能用以 scopes 里面列举的命名空间为前缀来发布,如果没设置则无法发布,也就是说这是一个必填项,默认为 [‘@cnpm’, ‘@cnpmtest’, ‘@cnpm-test’],据苏千大大解释是为了便于管理以及让公司的员工自觉按需发布;更多关于 NPM scope 的说明请参见 npm-scope;
  • privatePackages:就如该配置项的注释所述,出于历史包袱的原因,有些已经存在的私有包(可能之前是用 Git 的方式安装的)并没有以命名空间的形式来命名,而这种包本来是无法上传到 CNPM 的,这个配置项数组就是用来加这些例外白名单的,默认为一个空数组;
  • sourceNpmRegistry:更新源 NPM 的 registry 地址,默认为 https://registry.npm.taobao.org;
  • sourceNpmRegistryIsCNpm:源 registry 是否为 CNPM,默认为 true,如果你使用的源是官方 NPM 源,请将其设为 false;
  • syncByInstall:如果安装包的时候发现包不存在,则尝试从更新源同步,默认为 true;
  • syncModel:更新模式(不过我觉得是个 typo),有下面几种模式可以选择,默认为 “none”;
  • “exist”:定时同步已经存在于数据库的包;
  • “all”:定时同步所有源站的包;
  • syncInterval:同步间隔,默认为 “10m” 即十分钟;
  • syncDevDependencies:是否同步每个包里面的 devDependencies 包们,默认为 false;
  • badgeSubject:包的 badge 显示的名字,默认为 cnpm;
  • userService:用户验证接口,默认为 null,即无用户相关功能也就是无法有用户去上传包,该部分需要自己实现接口功能并配置,如与公司的 Gitlab 相对接,这也是后话了;
  • alwaysAuth:是否始终需要用户验证,即便是 $ cnpm install 等命令;
  • httpProxy:代理地址设置,用于你在墙内源站在墙外的情况。
启动 cnpm 服务器
node <--harmony_generators> dispatch.js # 默认会打开两个端口,7001 用于 NPM 的注册服务,7002 用于 Web 访问。--harmony_generators 开启 v8 的和谐模式 可以不打开

如果端口禁用了,设置防火墙允许端口号:

// 打开 registry 的端口号
firewall-cmd --add-port=7001/tcp --zone=public  --permanent
// 打开 web 默认的端口号
firewall-cmd --add-port=7002/tcp --zone=public  --permanent
// 重置防火墙, 使刚刚的配置生效
firewall-cmd --reload
配置 cnpm 的 registry(注册表、挂号处)指向私库地址
npm config set registry < 私库地址 > # 比如 http://10.211.55.10:7001/
npm config get registry # 查看 registry 信息
npm config ls # 同上
发布包
npm version patch # 如果不是第一次发布,而是更新版本,必须执行
npm publish --registry=http://10.211.55.10:7001
npm view < 包名 > versions # 查看发布后版本
  • 升级版本号

    升级补丁版本号:npm version patch
    升级副版本号:npm version minor
    升级主版本号:npm version major

  • 版本号相关说明,npm version 后面参数说明:
    patch:小变动,比如修复 bug 等,版本号变动 v1.0.0->v1.0.1
    minor:增加新功能,不影响现有功能,版本号变动 v1.0.0->v1.1.0
    major:破坏模块对向后的兼容性,版本号变动 v1.0.0->v2.0.0
  • 撤销或删除发布的包版本:npm unpublish --force
退出移动版