快速开始

ohpm-repo私仓不允许在Linux或macOS系统中使用root用户启动，请使用普通用户安装运行。

如何安装

1. ohpm-repo依赖于Node运行，请提前安装Nodejs，并完成环境变量的配置，推荐Node.js18.x版本。具体安装请参考Node.js官方网站。

2. 下载ohpm-repo私仓工具包。请在下载中心获取最新的ohpm-repo，并根据下载中心页面工具完整性指导进行完整性校验。

3. 解压ohpm-repo私仓工具包。

   

4. 请将ohpm-repo工具包解压目录中bin目录的路径配置到系统环境变量path中，执行如下查询命令:

   ohpm-repo -v

   终端输出版本号（如：2.0.0），则表示安装包解压无问题。如有报错，请参考常见问题FAQ解决。

   

   针对Linux和Mac系统，建议使用bash或zsh作为命令行界面。如果使用其他类型shell，写入ohpm-repo部署根目录deploy_root的环境变量时，默认写入.bashrc文件中。

5. 在启动ohpm-repo前，需要先按照如下方式完成配置修改：进入ohpm-repo解压目录的conf目录内，打开config.yaml配置文件。

   

   ohpm-repo成功启动后修改配置文件方法：

   • 首次启动ohpm-repo时执行install命令已指定配置文件：找到指定的配置文件进行文件内容修改，然后重新执行install指定修改后的配置文件，再执行start启动ohpm-repo。
   • 首次启动ohpm-repo时执行install命令未指定配置文件：默认使用ohpm-repo压缩包解压路径下conf目录中的配置文件，修改该文件内容，然后重新执行install和start操作。

6. 检查listen配置，默认配置为localhost:8088，表示仅支持监听本机地址；如果希望其他机器通过ip/域名访问，则建议修改listen配置为ohpm-repo部署机器的ip：

   listen: <部署ohpm-repo机器的ip>:8088

7. 检查deploy_root配置：如果不配置，会存储在默认地址中。该路径不允许配置为ohpm-repo解压根目录。

8. 检查db和store配置，db是元数据存储的配置项，store是文件存储的配置项。db支持fileDB本地存储和mysql数据库存储，store支持file storage本地存储，sftp storage存储和custom storage自定义插件存储。db和store不能随意搭配，需要符合表1的匹配规范。配置文件默认db使用fileDB本地存储，store使用file storage本地存储。

   表1 db配置项与store配置项的搭配选择

   db：元数据存储	与db所适配的store类型
   fileDB	file storage
   mysql	file storage，sftp storage， custom storage

9. 检查是否配置了store.config.server，用于指定ohpm-repo仓库内容的下载地址、不配置取默认值，详情见：server: 仓库内容的下载地址。如果listen的host为0.0.0.0，且本机存在多个网络接口，那么该值必须配置，建议手动修改host为本机指定的ip/域名，例如listen为0.0.0.0:8088，故server需配置为http://<指定部署机器的ip/域名>:8088。

   

   • 如果为ohpm-repo服务配置了反向代理服务器，则该地址需要填写为反向代理服务器的地址。
   • 如果ohpm-repo以多实例方式启动，必须配置反向代理服务器，多个实例之间需要统一的下载地址。
   • config.yaml中各项配置的详细描述请见：配置文件。

10. 进入ohpm-repo工具包解压目录中的bin目录下，执行安装命令:

    ohpm-repo install

    结果实例：

    

11. 安装成功后，必须根据给出的提示信息刷新部署目录的环境变量，针对Windows系统和Linux/Mac系统，有不同处理方式：

    • Windows系统：关闭当前窗口，重新开启一个窗口。
    • Linux/Mac系统：在命令行中执行刷新命令：当shell为bash时执行source ~/.bashrc或者.~/.bashrc；当shell为zsh时执行source ~/.zshrc或者. ~/.zshrc。

如何启动

ohpm-repo安装成功后，进入ohpm-repo工具包解压目录下的bin目录下，执行如下命令，启动ohpm-repo：

ohpm-repo start

启动成功，将会出现以下日志信息：

ohpm-repo首次启动时，默认创建一个管理员账号，账号名称：admin，密码：12345Qq!。该账号在首次登录时，需要修改其密码，请修改密码后，重新登录该账号。

从ohpm-repo获取三方库

可以为所有项目配置该私有仓，例如执行以下命令：

ohpm config set registry <配置的ohpm-repo私仓服务地址>/repos/ohpm
ohpm install

或者在命令行中配置参数--registry使用，例如以下命令：

ohpm install @ohos/lottie --registry <配置的ohpm-repo私仓服务地址>/repos/ohpm

<配置的ohpm-repo私仓服务地址>：配置文件中store.config.server的地址信息，例如：**store.config.server:为http://127.0.0.1:8088**，故registry为：**http://127.0.0.1:8088/repos/ohpm。**如果store.config.server没有配置，取默认值。

将三方库发布到ohpm-repo

三方库包含静态共享包HAR包和动态共享包HSP包，可以通过ohpm命令行工具和使用Web页面两种方式发布。

从ohpm命令行工具1.3.0版本和ohpm-repo私仓1.1.0版本开始，支持动态共享包HSP包以.tgz文件形式发布到ohpm-repo，之前版本仅支持发布以.har文件形式的静态共享包。

使用命令行工具发布

1. 利用工具ssh-keygen生成公、私钥，可执行以下命令：

   ssh-keygen -m PEM -t RSA -b 4096 -f <your_key_path>

   

   • <your_key_path>：配置公钥和私钥的名称和存放路径，仅包含名称时，以当前命令行工作路径为存储目录。
   • OHPM包管理器只支持加密密钥认证，请在生成公私钥时输入密码。

   示例：

   ssh-keygen -m PEM -t RSA -b 4096 -f D:\path\my_key_path

   

   公钥和私钥存储在D盘的path目录下，公钥和私钥名称分别为my_key_path.pub和my_key_path。

2. 登录ohpm-repo私仓管理地址，单击主页右上角的个人中心 > 认证管理，新增公钥，将公钥文件（<your_key_path>.pub）的内容粘贴到公钥输入框中。

   

3. 打开命令行工具，执行如下命令设置私钥路径。

   ohpm config set key_path <your_key_path>

4. 登录ohpm-repo私仓管理地址，单击主页右上角的个人中心，复制发布码。

   

5. 将发布码配置到.ohpmrc文件中，可执行如下命令：

   ohpm config set publish_id <your_publish_id>

6. 三方库包含静态共享包HAR包和动态共享包HSP包，发布方式存在不同。

   • 静态共享包HAR包

     执行 ''ohpm publish <HAR包路径>'' 命令发布HAR包，<HAR包路径> 指向的文件后缀需为.har文件的具体路径。例如执行以下命令：

     ohpm config set publish_registry <ohpm-repo私仓管理地址>/repos/ohpm
     ohpm publish demo.har

     或在命令行中配置参数--publish_registry使用，例如以下命令：

     ohpm publish demo.har --publish_registry <ohpm-repo私仓管理地址>/repos/ohpm

   • 动态共享包HSP包

     动态共享包HSP包不能直接发布在ohpm-repo内，需要先转换为.tgz包，转换方法见：编译HSP模块。TGZ包的发布流程同HAR一致。

     执行 ''ohpm publish <TGZ包路径>'' 命令发布TGZ包，< TGZ 包路径> 指向的文件后缀需为.tgz文件的具体路径。例如执行以下命令：

     ohpm config set publish_registry <ohpm-repo私仓管理地址>/repos/ohpm
     ohpm publish demo.tgz

     或在命令行中配置参数--publish_registry使用，例如以下命令：

     ohpm publish demo.tgz --publish_registry <ohpm-repo私仓管理地址>/repos/ohpm

   

   • 开发HAR包和HSP包，HSP生成.tgz包和.tgz格式共享包转换为.har格式等更详细内容请参考：开发及引用共享包。
   • 发布时ohpm-repo私仓管理地址填写规则如下：
     • listen的host不为0.0.0.0时， 管理地址使用listen的完整格式，例如：当listen：localhost:8088，此处ohpm-repo私仓管理地址应填写：http://localhost:8088。
     • listen的host为0.0.0.0时，host需更改为ohpm-repo私仓部署机器的ip/域名，例如：当listen：0.0.0.0:8088，此处ohpm-repo私仓管理地址应填写：http://<ohpm-repo私仓部署机器的ip/域名>:8088。

使用Web页面发布

在Web页面用管理员账号登录ohpm-repo私仓管理地址，在个人中心 > 仓库管理中，点击管理三方包 > 上传三方包，包的后缀名必须为.har或者.tgz。