1Panel 应用商店如何上架应用

1Panel应用商店上架指南

最新推荐文章于 2025-12-03 18:49:33 发布

原创

最新推荐文章于 2025-12-03 18:49:33 发布 · 799 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#运维 #1Panel

本文首发于 Anyeの小站，点击阅读原文体验更佳。

前言

本文作为一篇对于 1Panel 应用商店应用的详细开发文档，~~修复了官方文档久久不更新的BUG~~，同时可以将本文内容喂给 AI 以获得较为完美的 AI 协作。

准备工作

确保您的应用程序符合 1Panel 应用商店的上架要求，具体要求请参考应用上架前提。
准备好应用的相关信息，包括名称、描述、图标等。
确保您的应用可以在 1Panel 环境中正常运行。

文件夹格式

├── halo                // 应用根目录
    ├── logo.png        // 应用 logo , 最好是 180 * 180 px,不要超过 10 KB
    ├── 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 说明

# === 官方应用商店兼容字段（上架官方商店必填，其余情况选填） ===
# https://apps.fit2cloud.com/1panel
# 显示名称
name: Halo
# 分类标签
tags: 建站
# 副标题
title: 强大易用的开源建站工具
# 应用描述
description: 强大易用的开源建站工具

# === 以下为 1Panel 应用商店解析的数据结构，必须保留此结构 ===
additionalProperties:
  # === 必填字段 ===
  # 应用程序唯一标识符，用于系统内部识别及创建文件夹，仅限英文（必填）
  key: halo
  # 应用程序显示名称（必填）
  name: Halo
  # 应用程序类型（必填）
  # 可选值: website: 网站应用，支持在1Panel中一键部署，如 Wordpress、Halo等
  #        runtime: 运行时环境，如 MySQL、Redis、OpenResty 等
  #        tool: 工具类应用，大部分应用不属于上述两类的，可归为工具类，如 FileBrowser、phpMyAdmin 等
  type: website
  # 分类标签数组，用于应用商店分类显示（必填），可选值可见：https://github.com/1Panel-dev/appstore/blob/dev/data.yaml
  tags:
    - Website

  # === 描述信息字段（选填，建议填写）===
  # 中英文描述，建议20-30个字符，v1 版本格式
  shortDescZh: 强大易用的开源建站工具
  shortDescEn: Powerful and easy-to-use open source website builder
  # 多语言描述，建议20-30个字符，v2 版本格式
  description:
    # 简体中文
    zh: 强大易用的开源建站工具
    # 繁体中文
    zh-hant: 強大易用的開源建站工具
    # 英文
    en: A powerful and easy-to-use open source website building tool
    # 日语
    ja: 強力で使いやすいオープンソースのウェブサイト構築ツール
    # 马来语
    ms: Alat pembinaan laman web sumber terbuka yang kuat dan mudah digunakan
    # 巴西葡萄牙语
    pt-br: Uma ferramenta de construção de sites de código aberto poderosa e fácil de usar
    # 俄语
    ru: Мощный и удобный инструмент с открытым исходным кодом для создания веб-сайтов
    # 韩语
    ko: 강력하고 사용하기 쉬운 오픈소스 웹사이트 구축 도구
    # 土耳其语
    tr: Güçlü ve kullanımı kolay açık kaynaklı web sitesi oluşturma aracı

  # === 功能配置字段（选填）===
  # 是否支持跨版本更新，默认false
  crossVersionUpdate: true
  # 安装数量限制，0表示无限制，默认0
  limit: 0
  # 推荐级别，数值越小越推荐，用于应用商店排序，默认9999
  recommend: 5

  # === 链接信息字段（选填）===
  # 官方网站链接，必须是有效的 HTTP/HTTPS URL
  website: https://halo.run/
  # GitHub 仓库链接，必须是有效的HTTP/HTTPS URL
  github: https://github.com/halo-dev/halo
  # 文档链接，必须是有效的HTTP/HTTPS URL
  document: https://docs.halo.run/

  # === 系统要求字段（选填）===
  # 内存要求（MB），用于系统资源检查和用户提示
  # 常见值：512, 1024, 2048, 4096
  memoryRequired: 1024
  # 支持的 CPU 架构数组
  # 可选值：amd64, arm64, armv7, ppc64le, s390x, riscv64
  architectures:
    - amd64
    - arm64
    - ppc64le
    - s390x
  # 是否需要GPU支持，默认false
  gpuSupport: false

  # === 版本兼容性字段（选填）===
  # 最低面板版本要求，0表示无要求，默认0
  # 示例：1.0, 1.5, 2.0
  version: 0
  # 废弃版本标记，0表示未废弃，默认0，若不为 0，则与当前系统版本号对比，若大于等于该版本号，则不出现在应用商店中
  deprecated: 0

README.md 编写要求

## 基本结构规范

## 产品介绍

用一句或一段话简要介绍应用的主要功能和用途。

## 默认账户信息

如果应用有默认登录凭据，应在文件开头明确标注。

## 主要功能

使用 "## 主要功能" 或 "## 关键特性" 作为二级标题，然后用项目符号列表详细描述各项功能。

### 分类组织

对于复杂功能，使用三级标题进行分类组织，每个分类下用项目符号详细说明。

## 配置和使用说明

### 注意事项

重要的使用注意事项应放在显眼位置，使用 "## 注意事项" 标题。

### 配置步骤

详细的配置说明应使用清晰的步骤格式，包含具体的命令和路径。代码示例应使用适当的语法高亮。

项目应提供中英文两个版本的 README 文件，分别命名为 README.md（中文）和 README_en.md（英文）。

命令和配置示例应使用适当的代码块格式，并标注语言类型以获得正确的语法高亮。

应用的参数配置 data.yml 说明

版本目录下的 data.yml 文件用于定义应用程序特定版本的安装参数和表单字段配置。

基本结构如下：

# === 配置文件说明 ===
# 路径：应用程序版本目录下（如 1.0.0/data.yml）
# 用途：定义对应版本应用的安装参数及表单字段配置，支撑 1Panel 平台安装流程的参数解析与用户交互

# === 核心数据结构（必须保留）===
additionalProperties:
  # 用户安装应用时需填写的配置参数列表
  formFields:
    # ------------------------------
    # 基础演示字段（通用文本输入示例）
    # ------------------------------
    - type: "text" # 字段类型：text(通用文本) / password(敏感密码) / select(下拉选择) / service(服务选择) / number(数字输入)
      labelZh: "演示标签" # 中文显示标签（必填）
      labelEn: "Demo Label" # 英文显示标签（必填）
      # 多语言标签配置（可选，建议补充以支持多语言环境）
      label:
        zh: "演示标签"