PiHole 浏览器扩展程序安装与使用手册

项目概述

PiHole 浏览器扩展是一款轻量级的应用，专为Chrome和Firefox浏览器设计，采用Vue.js和TypeScript开发。该扩展允许用户远程控制他们的PiHole设备，实现诸如开关服务、黑白名单当前标签页等功能。

目录结构及介绍

以下是基于提供的源代码链接中可以推断的典型项目目录结构及其大致内容：

pihole-browser-extension
├── _locales           # 多语言资源文件夹，存放不同语言的翻译文件
├── eslintignore       # ESLint忽略文件配置
├── eslintrc.js        # ESLint规则配置文件
├── gitignore          # Git忽略文件列表
├── prettierignore     # Prettier代码格式化忽略文件列表
├── prettierrc         # Prettier代码格式化配置文件
├── LICENSE            # 许可证文件，表明项目遵循MIT协议
├── PRIVACY            # 隐私政策相关说明
├── README.md          # 项目的主要说明文件，包括简介和基本使用指南
├── manifest.chrome.json    # Chrome扩展的清单文件，定义扩展功能和权限
├── manifest.firefox.json   # Firefox扩展的清单文件，适应Firefox浏览器的要求
├── package-lock.json     # NPM包依赖锁定文件，确保团队成员间依赖版本一致
├── package.json         # 包管理配置文件，列出所有依赖项和脚本命令
├── tsconfig-for-webpack-config.json # 特定于webpack配置的TypeScript配置
├── tsconfig.json        # 主TypeScript编译配置文件
└── src                 # 源代码文件夹，包含核心逻辑和UI组件
    ├── ...             # 具体的TypeScript源码文件，如组件、服务等

启动文件介绍

在这样的项目中，启动文件通常位于src目录下或者通过构建脚本指定。不过，对于浏览器扩展，其“启动”更多指的是用户端的操作，即点击浏览器中的扩展图标来激活扩展功能。开发者层面的“启动”，可能涉及到运行开发服务器或打包流程，这通常由一个NPM脚本触发，比如npm start用于本地开发环境预览，而npm run build则是为了生产环境打包。

配置文件介绍

此项目主要的配置不在运行时进行编辑，而是通过用户界面进行设置，连接到用户的Pi-Hole实例。但是，从开发的角度看，关键的配置文件是：

• manifest.*.json 文件：这两个文件（分别为Chrome和Firefox）是浏览器扩展的关键配置，它们定义了扩展的名称、描述、所需权限、图标和其他元数据，以及脚本和页面的入口点。

• tsconfig.json：TypeScript编译配置，影响源码编译成JavaScript的方式，包括编译目标、模块系统等。

用户在使用过程中，需要手动在扩展的设置中输入Pi-Hole主机地址和API密钥，这部分配置是动态的，不直接存储在项目源代码内。

---

请注意，上述信息基于项目结构的一般理解，实际使用还需参考项目仓库中的具体文件和官方文档。如果存在特定的启动脚本或配置指令，应参照package.json中的scripts部分和项目说明文档。