首页
/ ArtiPub浏览器扩展安装与开发指南

ArtiPub浏览器扩展安装与开发指南

2025-07-10 03:19:14作者:卓炯娓

什么是ArtiPub浏览器扩展

ArtiPub浏览器扩展是为ArtiPub项目配套开发的浏览器插件工具,它能够帮助用户更方便地使用ArtiPub平台的功能。该扩展提供了跨浏览器支持,包括Chrome和Firefox两大主流浏览器。

安装指南

Chrome浏览器安装步骤

  1. 下载Chrome扩展压缩包(chrome.zip)
  2. 解压下载的压缩文件到本地目录
  3. 打开Chrome浏览器,在地址栏输入chrome://extensions/进入扩展管理页面
  4. 开启右上角的"开发者模式"开关
  5. 点击"加载已解压的扩展程序"按钮
  6. 选择之前解压的扩展目录进行安装

Firefox浏览器安装步骤

  1. 下载Firefox扩展文件(firefox.xpi)
  2. 打开Firefox浏览器
  3. 直接将.xpi文件拖拽到浏览器窗口中
  4. 按照提示完成安装

开发与打包指南

开发环境准备

项目使用Yarn作为包管理工具,推荐使用Yarn或Tyarn进行开发,使用npm可能会出现兼容性问题。

首先需要安装项目依赖:

yarn install

构建命令

  • 完整构建(同时构建Chrome和Firefox扩展):

    yarn run build
    
  • 仅构建Chrome扩展:

    yarn run build:chrome
    
  • 仅构建Firefox扩展:

    yarn run build:firefox
    

Firefox扩展签名说明

构建Firefox扩展时,系统会检查以下两个环境变量:

  1. WEB_EXT_API_KEY - Mozilla开发者API密钥
  2. WEB_EXT_API_SECRET - Mozilla开发者API密钥对应的密钥

如果这两个环境变量存在,构建过程会使用Mozilla的Web-Ext工具进行签名,生成可直接安装的已签名扩展包。

如果环境变量不存在,则会生成未签名的扩展包,需要通过Firefox的调试模式临时加载使用。

环境变量配置

可以通过创建.env文件来配置环境变量,具体配置方式可参考项目中的webpac.prod.js文件。

技术实现

ArtiPub浏览器扩展基于web-extension-starter项目构建,这是一个优秀的浏览器扩展开发脚手架,提供了现代化的开发工具链和跨浏览器支持能力。

注意事项

  1. 开发过程中建议使用Chrome和Firefox的开发者工具进行调试
  2. 对于Firefox扩展,未签名版本仅适用于开发和测试环境
  3. 生产环境使用的Firefox扩展必须经过Mozilla官方签名
  4. 扩展的API权限声明需要严格遵守各浏览器的安全策略

通过本文的介绍,开发者可以快速上手ArtiPub浏览器扩展的安装和使用,也能了解如何进行二次开发和自定义构建。该扩展作为ArtiPub生态的重要组成部分,能够显著提升用户的使用体验。