1.选择
鸿蒙提供ohpm-repo工具用于构建本地私有仓储
2.环境配置
安装node,ohpm-repo 支持 node.js 18.x 及以上版本
3.配置文件及运行
1.解压 ohpm-repo 私仓工具包
2.进入 ohpm-repo 解压目录的 conf 目录内,打开 config.yaml 配置文件
bash
##### server configuration section #####
listen: localhost:8088 # 建议修改为具体的ip/域名
# listen:
# - localhost:8088 # 监听本机环回地址
# - http://localhost:8088 # 监听本机环回地址
# - 0.0.0.0:8088 # 监听本机所有地址 (INADDR_ANY)
# 协议可配置 http 或者 https,默认为 http
# port: 1-65535(Window系统)/ 1024-65535(Linux或Mac系统)
# 可选 (listen 为 https 协议时必须配置)
https_key: '' # https 服务使用的 key 的路径 (不配置默认为'')
https_cert: '' # https 服务使用的 crt 的路径 (不配置默认为'')
##### server deploy root section #####
deploy_root: '' # 安装根目录 (不配置默认为 `<现有用户home目录>/ohpm-repo`),只支持绝对路径,且路径目录必须存在
##### server numeric limit section #####
max_package_size: 300 # 上传包大小限制,单位是MB (0, 300],不配置默认为 300
max_extract_size: 800 # 压缩包解压后大小限制,单位是MB ,不配置默认为 800
max_extract_file_num: 30000 # 压缩包解压后文件个数限制,默认为30000个
user_rate_limit: 100 # 用户访问频率控制,单位是次/s (0, 10000],不配置默认为 100
fetch_timeout: 60 # 请求/响应的超时时间,单位是秒 (0, 3600],不配置默认为 60
keep_alive_timeout: 60 # TCP 保持连接的超时时间,单位是秒 (0, 3600],不配置默认为 60
api_timeout: 60 # api超时时间,单位是秒(0, 3600],不配置默认为 60
upload_lock_hour: 24 # 下架某一三方包所有版本后,限时禁止同名三方包上传,单位是小时 (0, 168],不配置,默认为 24
upload_max_times: 100 # 单用户24小时内上传次数限制 (0, 100000],不配置默认为 100
operation_log_retention: 100 # 数据库中操作日志保留时间,单位是天,不配置默认为 100
##### metadata storage section #####
## 数据存储类型 filedb 和 mysql 二选一,不可都配置
db: # 必须用 yaml 数组形式写法
type: filedb
config: # 如果想修改存储路径且保留旧的数据,则需要把旧路径下的数据文件迁移至新路径
path: ./db # 本地数据存储路径,不配置默认为<deploy_root>/db;
#db: # 必须用yaml数组形式写法
# type: mysql
# config:
# host: "localhost" # 数据库主机地址
# port: 3306 # 数据库端口 (0,65535]
# username: root # 数据库的用户名
# password: "password" # 数据库的用户密码(请配置明文, 最终在部署目录中会转换为密文)
# database: "repo" # 数据库名
##### storage section #####
## 文件存储类型fs,sftp 和 custom 三选一,不可多选。
store: # 必须用 yaml 数组形式写法
type: fs
config: # 上传资源后如若要修改存储路径,则需要把旧路径下的数据迁移至新路径中
path: ./storage # 已上架三方库存储路径,不配置默认为 <deploy_root>/storage;
#server: http://localhost:8088 # 仓库下载链接地址,不配置取默认值
# 文件存储类型为 sftp 时,最多配置三个 sftp
#store: # 必须用 yaml 数组形式写法
# type: sftp # 当且仅当 db 的类型为 mysql 时,store 的类型才能为 sftp
# config:
# location:
# -
# name: test_one_sftp # 主机名字名字不能与其他sftp配置重复
# host: "localhost" # 主机地址
# port: 22 # 主机端口 (0,65535]
# read_username: "read" # 主机有读权限的用户名字
# read_password: "password" # 主机有读权限的用户密码(请配置明文, 最终在部署目录中会转换为密文)
# write_username: "write" # 主机有写权限的用户名字
# write_password: "password" # 主机有写权限的用户密码(请配置明文, 最终在部署目录中会转换为密文)
# path: /source22 # 相对 sftp 根目录的文件路径,仅限/开头,且路径文件夹必须存在
# -
# name: test_two_sftp
# host: "localhost"
# port: 24
# read_username: "read"
# read_password: "password"
# write_username: "write"
# write_password: "password"
# path: /source24
# #server: http://localhost:8088 # 仓库下载链接地址,不配置取默认值
#store:
# type: custom # custom是自定义存储插件类型,自定义存储插件开发流程见指导文档
# config:
# export_name: CustomStorage # 插件export的类名
# plugin_path: plugins/CustomStorage.js # 插件的绝对路径或者相对于ohpm-repo软件包的路径,建议将插件放在软件包的plugins目录下
# custom_field: "test" # 自定义字段,通过引入libs/common/getStorageConfigInfo.js的getStorageConfigInfo方法获取自定义字段的值
# #server: http://localhost:8088 # 仓库下载链接地址,不配置取默认值
##### uplink section #####
uplink_cache_path: ./uplink # 缓存路径,不配置默认为 <deploy_root>/uplink
uplink_cache_time: 168 # 远程包 metadata 缓存时间,单位为小时,默认 168 小时,取值范围为 (0, 8760]
##### log section #####
logs_path: ./logs # 日志路径,不配置默认为 <deploy_root>/logs
##### log level section #####
# 日志级别: 级别由低到高分别是 all、trace、debug、info、warn、error、fatal、mark、off
# run,operate 和 access 不配置或者配置错误,默认为 info
loglevel_run: info
loglevel_operate: info
loglevel_access: info
##### auth plugin section #####
# 可选项,自定义认证插件配置
#auth_plugin:
# name: CustomAuth # 认证插件的名字
# path: plugins/CustomAuth.js # 插件的绝对路径或者相对于ohpm-repo软件包的路径,建议将插件放在软件包的plugins目录下
##### compatibleSdkVersion等兼容性字段检测日志等级 #####
# 可选值:close、info、warn、error,默认:warn
compability_log_level: warn
##### 是否允许下架被其他组件依赖的包 #####
# 可选项:true,false, 默认:false
allow_remove_depended_packages: false
##### 是否使用文件上传新接口 #####
# 可选项:true,false, 默认:true
allow_new_file_upload_api: true
主要是修改
- listen: <部署ohpm-repo机器的ip>:8088
- deploy_root: '~/AppData/Roaming/Huawei/ohpm-repo'
3.运行
进入ohpm-repo工具包解压目录中的 bin 目录下,检查环境是否ok,出现版本号为ok
bash
ohpm-repo -v
进入ohpm-repo工具包解压目录中的 bin 目录下,执行安装命令
bash
ohpm-repo install
这时在环境变量会增加deploy_root这个参数值
ohpm-repo安装成功后,进入ohpm-repo工具包解压目录下的 bin 目录下,执行如下命令,启动 ohpm-repo:
bash
ohpm-repo start
运行结果为下面图,则代表成功
4.登录后台
http://localhost:8088/ (<部署ohpm-repo机器的ip>:8088)
ohpm-repo 首次启动时,默认创建一个管理员账号,账号名称:admin ,密码:12345Qq! ,需要更改密码
修改后,登录
在仓库管理可以看到仓库名
5.三方库发布到私有仓储
1.web后台发布
在Web页面用管理员账号登录ohpm-repo私仓管理地址,在个人中心 > 仓库管理中,点击管理三方包 > 上传三方包,包的后缀名必须为 .har 或者 .tgz。
2. 配置项目私有仓储
在用户目录下有.ohpm文件夹里面有.ohpmrc
### 仓库配置,支持配置多个地址,使用英文逗号分割
registry=https://repo.harmonyos.com/ohpm/
# registry=https://ohpm.openharmony.cn/ohpm/
## 支持配置含有group的仓库,优先匹配
#@group1:registry=
#@group2:registry=
### 代理配置
#no_proxy=
#http_proxy=
#https_proxy=
### 证书校验配置
## 是否校验https仓库的证书,取值:true|false, default: true, 为true时需要配置ca_files证书路径
strict_ssl=true
#ca_files=
### 发布配置
## 因为registry支持配置多仓,所以此处需明确指定发布仓
publish_registry=https://repo.harmonyos.com/ohpm/
## 用户发布三方库的发布id,从云端个人中心获取
#publish_id=
## 用户私钥文件路径,公钥需在云端进行配置
#key_path=
### 缓存路径, 默认在用户目录下的.ohpm/cache
#cache=
### 日志级别, 取值:debug|info|warn|error, default: info
log_level=info
### 网络请求超时时间, 单位ms, 默认为60s
fetch_timeout=60000
配置registry地址(用于拉取)和publish_registry(用于上传)
-
ohpm config set registry <配置的ohpm-repo私仓服务地址>/repos/ohpm 也可以ohpm install @ohos/lottie --registry <配置的ohpm-repo私仓服务地址>/repos/ohpm
-
ohpm config set publish_registry <ohpm-repo私仓管理地址>/repos/ohpm
registry=http://192.168.158.99:8087/repos/ohpm
strict_ssl=true
publish_registry=http://192.168.158.99:8087/repos/ohpm
log_level=info
fetch_timeout=60000
如果要发布,还需要配置rsa和publish_id
利用工具 ssh-keygen 生成公、私钥,必须输入passphrase(eg.123456)
ssh-keygen -m PEM -t RSA -b 4096 -f <your_key_path>
// eg.
ssh-keygen -m PEM -t RSA -b 4096 -f D:\path\my_key_path
登录 ohpm-repo 私仓管理地址,单击主页右上角的个人中心,新增公钥,将公钥文件(<your_key_path>.pub)的内容粘贴到公钥输入框中
打开命令行工具,执行如下命令设置私钥路径
ohpm config set key_path <your_key_path>
登录 ohpm-repo 私仓管理地址,单击主页右上角的个人中心,复制发布码
将发布码配置到 .ohpmrc 文件中,可执行如下命令
ohpm config set publish_id <your_publish_id>
3.命令行发布
静态共享包HAR包
ohpm config set publish_registry <ohpm-repo私仓管理地址>/repos/ohpm
ohpm publish demo.har
或者
ohpm publish demo.har --publish_registry <ohpm-repo私仓管理地址>/repos/ohpm
动态共享包 HSP 包
动态共享包 HSP 包不能直接发布在ohpm-repo内,需要先转化为 .tgz 包,转换方TGZ 包的发布流程同 HAR 一致。
ohpm config set publish_registry <ohpm-repo私仓管理地址>/repos/ohpm
ohpm publish demo.tgz
或者
ohpm publish demo.tgz --publish_registry <ohpm-repo私仓管理地址>/repos/ohpm
组件上传后,在ohpm-repo
6.使用上传到私有仓储的库
参考5.2 配置项目私有仓储,设置好registry
ohpm config set registry <配置的ohpm-repo私仓服务地址>/repos/ohpm 或者
ohpm install @ohos/lottie --registry <配置的ohpm-repo私仓服务地址>/repos/ohpm