108 lines
3.7 KiB
Markdown
108 lines
3.7 KiB
Markdown
# Installer Builder 示例配置
|
||
|
||
本目录包含了多个示例配置文件，展示了如何使用Installer Builder为不同类型的应用程序创建安装包。这些示例涵盖了常见的应用场景和配置选项，可以作为您自己的配置文件的起点。
|
||
|
||
## 示例列表
|
||
|
||
### 1. [simple-app.yaml](./simple-app.yaml)
|
||
|
||
一个简单的跨平台应用示例，展示基本配置。这个示例适合初学者了解配置文件的基本结构和必要字段。
|
||
|
||
**主要特点：**
|
||
- 为Windows和Linux平台生成ZIP包
|
||
- 包含基本的文件和目录配置
|
||
- 演示安装前后脚本的使用
|
||
|
||
### 2. [windows-desktop-app.yaml](./windows-desktop-app.yaml)
|
||
|
||
Windows桌面应用示例，使用MSI包。这个示例展示了如何为Windows平台创建专业的安装包。
|
||
|
||
**主要特点：**
|
||
- 生成Windows MSI安装包
|
||
- 配置桌面和开始菜单快捷方式
|
||
- 设置注册表项
|
||
- 使用PowerShell脚本进行安装前后处理
|
||
|
||
### 3. [linux-service-app.yaml](./linux-service-app.yaml)
|
||
|
||
Linux服务应用示例，使用DEB和RPM包。这个示例展示了如何为Linux平台创建系统服务安装包。
|
||
|
||
**主要特点：**
|
||
- 同时生成DEB和RPM包
|
||
- 支持多架构（amd64和arm64）
|
||
- 配置systemd服务
|
||
- 创建系统用户和组
|
||
- 处理配置文件
|
||
|
||
### 4. [web-app.yaml](./web-app.yaml)
|
||
|
||
Web应用示例，使用ZIP包。这个示例展示了如何为Web应用创建部署包。
|
||
|
||
**主要特点：**
|
||
- 为多个平台生成ZIP包
|
||
- 包含前端和后端资源
|
||
- 配置Web服务器和数据库
|
||
- 使用Node.js脚本进行安装前后处理
|
||
|
||
### 5. [multi-platform-app.yaml](./multi-platform-app.yaml)
|
||
|
||
多平台应用示例，展示如何在一个配置文件中为多个平台和多种包类型配置安装包。
|
||
|
||
**主要特点：**
|
||
- 为Windows、Linux和macOS平台生成多种类型的安装包
|
||
- 根据平台选择不同的文件和目录
|
||
- 为每个平台配置特定的安装前后脚本
|
||
- 定义平台特定的依赖项
|
||
- 配置升级策略
|
||
|
||
### 6. [plugin-example.yaml](./plugin-example.yaml)
|
||
|
||
插件系统示例，展示如何使用插件扩展安装包构建器的功能。
|
||
|
||
**主要特点：**
|
||
- 使用代码签名插件对可执行文件进行签名
|
||
- 配置通知插件发送构建完成通知
|
||
- 使用压缩插件控制压缩级别和算法
|
||
- 配置自动更新插件
|
||
- 自定义安装向导
|
||
- 支持多语言本地化
|
||
- 使用自定义包类型插件
|
||
- 定义构建过程中的钩子点
|
||
|
||
## 使用方法
|
||
|
||
1. 查看示例配置文件，了解不同场景下的配置选项
|
||
2. 根据您的需求选择最接近的示例作为起点
|
||
3. 复制并修改配置文件以适应您的应用
|
||
4. 使用以下命令构建安装包：
|
||
|
||
```bash
|
||
installer-builder build --config your-config.yaml
|
||
```
|
||
|
||
## 配置文件结构
|
||
|
||
所有配置文件都遵循相同的基本结构：
|
||
|
||
1. **基本信息**：应用名称、版本、描述等
|
||
2. **构建目标**：定义要生成的安装包类型和平台
|
||
3. **文件和目录**：指定要包含在安装包中的文件和目录
|
||
4. **脚本**：定义安装前后要执行的脚本
|
||
5. **依赖项**：指定应用运行所需的依赖
|
||
6. **插件配置**：配置各种插件以扩展功能
|
||
|
||
## 自定义配置
|
||
|
||
这些示例提供了常见场景的起点，但您可能需要根据自己的需求进行自定义：
|
||
|
||
- 修改文件和目录路径以匹配您的项目结构
|
||
- 调整目标平台和包类型
|
||
- 自定义安装前后脚本
|
||
- 配置适合您应用的插件
|
||
- 添加特定于您应用的依赖项
|
||
|
||
## 更多资源
|
||
|
||
- 查看完整的[配置参考文档](../doc/config-reference.md)了解所有可用选项
|
||
- 阅读[插件开发指南](../doc/plugin-development.md)学习如何创建自己的插件
|
||
- 参考[最佳实践指南](../doc/best-practices.md)获取配置建议 |