Spaces:
Running
Running
title: Auto Build 1Panel APP | |
emoji: 🐨 | |
colorFrom: red | |
colorTo: pink | |
sdk: docker | |
pinned: false | |
license: mit | |
app_port: 8080 | |
# 自助创建 1Panel 应用 | |
该程序允许用户通过图形界面自助创建 [1Panel](https://1panel.cn/) 应用。用户可以输入应用的基本信息,编写相关配置文件,并生成可下载的应用包。 | |
## [在线使用]() | |
## 功能 | |
- **基本信息录入**:输入应用名称、Key、标签、描述、官网、GitHub 地址等基本信息。 | |
- **版本创建**:为应用创建不同版本的 `docker-compose.yml` 和 `data.yml` 文件。 | |
- **Logo 上传**:上传应用的 Logo,支持 PNG、JPG 格式。如果未上传 Logo,使用默认图片。 | |
- **README 编写**:支持使用 Markdown 编写 README 文件。 | |
- **文件压缩与下载**:将应用文件夹压缩为 ZIP 文件,并提供下载链接。 | |
## 依赖项 | |
- Python 3.x | |
- `pywebio` | |
- `PyYAML` | |
使用以下命令安装依赖: | |
```bash | |
pip install -r requirements.txt | |
``` | |
## 使用方法 | |
### 1. 启动程序 | |
在命令行中运行以下命令启动应用创建程序: | |
```bash | |
python main.py | |
``` | |
程序将在本地的 `8080` 端口启动。 | |
### 2. 填写应用信息 | |
根据提示输入以下信息: | |
- 应用名称、Key(仅限英文字符) | |
- 应用标签(可多选) | |
- 应用的中文与英文描述 | |
- 应用类型(工具类、站点类、运行时应用等) | |
- 是否支持跨大版本升级 | |
- 安装数量限制 | |
- 官网、GitHub、文档地址 | |
- Logo 图片上传(可选) | |
### 3. 创建应用版本 | |
在基本信息录入完成后,您可以创建应用的不同版本,分别编写 `docker-compose.yml` 和 `data.yml` 文件。 | |
### 4. 编写README | |
支持使用 Markdown 编写 README 文件,并将其保存至应用文件夹中。 | |
### 5. 下载应用文件 | |
所有信息输入完成后,程序将生成应用的 ZIP 包,并提供下载按钮。 | |
## 目录结构 | |
生成的应用包目录结构如下: | |
``` | |
apps/ | |
└── <应用Key>/ | |
├── data.yml | |
├── logo.png | |
├── README.md | |
└── <版本号>/ | |
├── data.yml | |
└── docker-compose.yml | |
``` | |
- `data.yml`: 包含应用的基本信息 | |
- `logo.png`: 应用的 Logo 图片 | |
- `README.md`: 应用的 README 文件 | |
- `<版本号>/`: 版本文件夹,包含版本特定的配置文件 | |
## 日志记录 | |
程序运行时会记录关键操作日志,默认日志级别为 `INFO`,可以在需要时查看日志以排查问题。 | |
## 贡献 | |
欢迎提交 issues 和 pull requests 以改进本程序。 |