(以 Halo 为例)
文件夹格式
├──halo // 以 halo 的 key 命名 ,下面解释什么是 key
├── logo.png // 应用 logo , 最好是 180 * 180 px
├── data.yml // 应用声明文件
├── README.md // 应用的 README
├── 2.2.0 // 应用版本 注意不要以 v 开头
│ ├── data.yml // 应用的参数配置,下面有详细介绍
│ ├── data // 挂载出来的目录
| ├── scripts // 脚本目录 存放 init.sh upgrade.sh uninstall.sh
│ └── docker-compose.yml // docker-compose 文件
└── 2.3.2
├── data.yml
├── data
└── docker-compose.yml
应用声明文件 data.yml
本文件主要用于声明应用的一些信息
additionalProperties: #固定参数
key: halo #应用的 key ,仅限英文,用于在 Linux 创建文件夹
name: Halo #应用名称
tags:
- WebSite #应用标签,可以有多个,请参照下方的标签列表
shortDescZh: 强大易用的开源建站工具 #应用中文描述,不要超过30个字
shortDescEn: Powerful and easy-to-use open source website builder #应用英文描述
type: website #应用类型,区别于应用分类,只能有一个,请参照下方的类型列表
crossVersionUpdate: true #是否可以跨大版本升级
limit: 0 #应用安装数量限制,0 代表无限制
website: https://halo.run/ #官网地址
github: https://github.com/halo-dev/halo #github 地址
document: https://docs.halo.run/ #文档地址
应用标签 - tags 字段:
key | name |
---|---|
WebSite | 建站 |
Server | Web 服务器 |
Runtime | 运行环境 |
Database | 数据库 |
Tool | 工具 |
CI/CD | CI/CD |
Local | 本地 |
应用类型 - type 字段: