NPM私有仓库Sinopia搭建及使用

Sinopia搭建

1.安装NodeJS及NPM

在Node.js中文网选择对应的系统进行下载并安装,安装完成后即可在终端上使用npm命令
安装完node后建议设置npm镜像以加速后面的过程(或使用科学上网工具),设置淘宝npm镜像如下:

npm config set registry https://registry.npm.taobao.org --global
npm config set disturl https://npm.taobao.org/dist --global

2.安装Sinopia

npm install -g sinopia

3.启动Sinopia

在终端输入sinopia即可启动Sinopia服务

enter description here

此时在浏览器输入 http://localhost:4873 ,可以查看服务是否启动成功。

enter description here

4.Sinopia配置

Sinopia的特点是,你在哪个目录运行,它的就会在对应的目录下创建自己的文件。目录下默认有两个文件:
config.yaml :sinopia配置文件
storage ,用户npm install时如果私有npm仓库中没有所需要的包,会从备用第三方库中拉取并缓存到该目录。下一次安装同样的包时就可以直接从私有npm仓库中拉取
htpasswd :添加用户之后自动创建
在第三步中可以得知sinopia配置文件路径。
config.yaml配置文件
我们需要对自动创建对配置文件进行一点修改:修改如下:

#
# This is the default config file. It allows all users to do anything,
# so don't use it on production systems.
#
# Look here for more config file examples:
# https://github.com/rlidwka/sinopia/tree/master/conf
#

# path to a directory with all packages
storage: ./storage  //npm包存放的路径

auth:
htpasswd:
file: ./htpasswd   //保存用户的账号密码等信息
# Maximum amount of users allowed to register, defaults to "+inf".
# You can set this to -1 to disable registration.
max_users: 1000  //默认为1000,改为-1为禁止注册,这样就只能通过修改htpasswd来注册用户

# a list of other known repositories we can talk to
uplinks:
npmjs:
url: http://registry.npm.taobao.org/  //默认为npm的官网,由于国情,修改 url 让sinopia使用 淘宝的npm镜像地址

packages:  //配置权限管理
'@*/*':
# scoped packages
access: $all
publish: $authenticated

'*':
# allow all users (including non-authenticated users) to read and
# publish all packages
#
# you can specify usernames/groupnames (depending on your auth plugin)
# and three keywords: "$all", "$anonymous", "$authenticated"
access: $all

# allow all known users to publish packages
# (anyone can register by default, remember?)
publish: $authenticated

# if package is not available locally, proxy requests to 'npmjs' registry
proxy: npmjs

# log settings
logs:
- {type: stdout, format: pretty, level: http}
#- {type: file, path: sinopia.log, level: info}

# you can specify listen address (or simply a port) 
listen: 0.0.0.0:4873  ////默认没有,只能在本机访问,添加后可以通过外网访问。

5.通过pm2启动sinopia

直接在终端通过sinopia命令启动服务时,如果关闭终端服务就被关闭了,所以一般会借助pm2工具进行进程守护管理。

pm2安装方式:

nam install -g pm2

通过pm2启动sinopia

pm2 start `which sinopia

如果需要停止sinopia服务,只需使用以下命令即可:

pm2 stop `which sinopia

Sinopia的使用

在使用sinopia之前,强烈推荐使用nrm来管理自己的npm代理,nrm可以快速修改,切换,增加npm镜像地址。
ps.我最终搭建的地址为http://10.10.13.15:4873 请自行修改为自己的服务器ip地址

npm install -g nrm # 安装nrm
nrm add sinopia http://10.10.13.15:4873 # 添加新搭建的npm私有仓库地址
nrm use sinopia

nrm的其他命令:

$ nrm --help  # 查看nrm命令帮助
$ nrm list # 列出可用的 npm 镜像地址
$ nrm use taobao # 使用`淘宝npm`镜像地址

npm 下载包

切换为新搭建的私有仓库后,npm的使用方式没有任何改变,仍是使用npm install xxx安装我们所需要的包。如果私有仓库中没有所需要的包,会从备用的镜像中下载并缓存到本地,下一次在进行安装时会直接从私有仓库中获取。

npm 发布包

要在私有npm仓库中发布包首先需要注册或登陆账号。
如果还没有账号,通过输入命令 npm adduser,然后依次输入用户名,密码,邮箱用户即可创建完毕。
如果已有账号,通过输入命令 npm login,然后依次输入用户名,密码,邮箱用户即可登陆。
然后进入你要上传的代码目录,执行初始化。

$ npm init

这个过程中要输入项目名,版本号,作者,开源协议等信息,自动生成package.json文件。
这里可以在这里填写相关信息或者直接回车跳过,因为后续可以直接修改package.json文件。
此外,通过在目录内新建README文件,可添加包的使用说明和用例代码。README文件支持markdown,书写十分方便。

然后执行发布命令就可以发布包到私有npm仓库了。

npm publish

可以通过浏览器访问http://10.10.13.15:4873 可以看到我们发布的私有包。

enter description here

你可能感兴趣的:(NPM私有仓库Sinopia搭建及使用)