Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
@@ -1,91 +1,102 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
|
18 |
-
|
19 |
-
|
20 |
-
|
21 |
-
|
22 |
-
|
23 |
-
|
24 |
-
|
25 |
-
|
26 |
-
|
27 |
-
|
28 |
-
|
29 |
-
|
30 |
-
|
31 |
-
|
32 |
-
|
33 |
-
|
34 |
-
|
35 |
-
|
36 |
-
|
37 |
-
|
38 |
-
|
39 |
-
|
40 |
-
|
41 |
-
|
42 |
-
|
43 |
-
|
44 |
-
|
45 |
-
|
46 |
-
|
47 |
-
|
48 |
-
|
49 |
-
|
50 |
-
|
51 |
-
|
52 |
-
|
53 |
-
|
54 |
-
|
55 |
-
|
56 |
-
|
57 |
-
|
58 |
-
|
59 |
-
|
60 |
-
|
61 |
-
|
62 |
-
|
63 |
-
|
64 |
-
|
65 |
-
|
66 |
-
|
67 |
-
|
68 |
-
|
69 |
-
|
70 |
-
|
71 |
-
|
72 |
-
|
73 |
-
|
74 |
-
|
75 |
-
|
76 |
-
|
77 |
-
|
78 |
-
|
79 |
-
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
|
85 |
-
|
86 |
-
|
87 |
-
|
88 |
-
|
89 |
-
|
90 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
91 |
欢迎提交 issues 和 pull requests 以改进本程序。
|
|
|
1 |
+
---
|
2 |
+
title: Auto Build 1Panel APP
|
3 |
+
emoji: 🐨
|
4 |
+
colorFrom: red
|
5 |
+
colorTo: pink
|
6 |
+
sdk: docker
|
7 |
+
pinned: false
|
8 |
+
license: mit
|
9 |
+
port: 8080
|
10 |
+
---
|
11 |
+
|
12 |
+
# 自助创建 1Panel 应用
|
13 |
+
|
14 |
+
该程序允许用户通过图形界面自助创建 [1Panel](https://1panel.cn/) 应用。用户可以输入应用的基本信息,编写相关配置文件,并生成可下载的应用包。
|
15 |
+
|
16 |
+
## [在线使用]()
|
17 |
+
|
18 |
+
## 功能
|
19 |
+
|
20 |
+
- **基本信息录入**:输入应用名称、Key、标签、描述、官网、GitHub 地址等基本信息。
|
21 |
+
- **版本创建**:为应用创建不同版本的 `docker-compose.yml` 和 `data.yml` 文件。
|
22 |
+
- **Logo 上传**:上传应用的 Logo,支持 PNG、JPG 格式。如果未上传 Logo,使用默认图片。
|
23 |
+
- **README 编写**:支持使用 Markdown 编写 README 文件。
|
24 |
+
- **文件压缩与下载**:将应用文件夹压缩为 ZIP 文件,并提供下载链接。
|
25 |
+
|
26 |
+
## 依赖项
|
27 |
+
|
28 |
+
- Python 3.x
|
29 |
+
- `pywebio`
|
30 |
+
- `PyYAML`
|
31 |
+
|
32 |
+
使用以下命令安装依赖:
|
33 |
+
|
34 |
+
```bash
|
35 |
+
pip install -r requirements.txt
|
36 |
+
```
|
37 |
+
|
38 |
+
## 使用方法
|
39 |
+
|
40 |
+
### 1. 启动程序
|
41 |
+
|
42 |
+
在命令行中运行以下命令启动应用创建程序:
|
43 |
+
|
44 |
+
```bash
|
45 |
+
python main.py
|
46 |
+
```
|
47 |
+
|
48 |
+
程序将在本地的 `8080` 端口启动。
|
49 |
+
|
50 |
+
### 2. 填写应用信息
|
51 |
+
|
52 |
+
根据提示输入以下信息:
|
53 |
+
|
54 |
+
- 应用名称、Key(仅限英文字符)
|
55 |
+
- 应用标签(可多选)
|
56 |
+
- 应用的中文与英文描述
|
57 |
+
- 应用类型(工具类、站点类、运行时应用等)
|
58 |
+
- 是否支持跨大版本升级
|
59 |
+
- 安装数量限制
|
60 |
+
- 官网、GitHub、文档地址
|
61 |
+
- Logo 图片上传(可选)
|
62 |
+
|
63 |
+
### 3. 创建应用版本
|
64 |
+
|
65 |
+
在基本信息录入完成后,您可以创建应用的不同版本,分别编写 `docker-compose.yml` 和 `data.yml` 文件。
|
66 |
+
|
67 |
+
### 4. 编写README
|
68 |
+
|
69 |
+
支持使用 Markdown 编写 README 文件,并将其保存至应用文件夹中。
|
70 |
+
|
71 |
+
### 5. 下载应用文件
|
72 |
+
|
73 |
+
所有信息输入完成后,程序将生成应用的 ZIP 包,并提供下载按钮。
|
74 |
+
|
75 |
+
## 目录结构
|
76 |
+
|
77 |
+
生成的应用包目录结构如下:
|
78 |
+
|
79 |
+
```
|
80 |
+
apps/
|
81 |
+
└── <应用Key>/
|
82 |
+
├── data.yml
|
83 |
+
├── logo.png
|
84 |
+
├── README.md
|
85 |
+
└── <版本号>/
|
86 |
+
├── data.yml
|
87 |
+
└── docker-compose.yml
|
88 |
+
```
|
89 |
+
|
90 |
+
- `data.yml`: 包含应用的基本信息
|
91 |
+
- `logo.png`: 应用的 Logo 图片
|
92 |
+
- `README.md`: 应用的 README 文件
|
93 |
+
- `<版本号>/`: 版本文件夹,包含版本特定的配置文件
|
94 |
+
|
95 |
+
|
96 |
+
## 日志记录
|
97 |
+
|
98 |
+
程序运行时会记录关键操作日志,默认日���级别为 `INFO`,可以在需要时查看日志以排查问题。
|
99 |
+
|
100 |
+
## 贡献
|
101 |
+
|
102 |
欢迎提交 issues 和 pull requests 以改进本程序。
|