mirror of
https://github.com/okxlin/appstore.git
synced 2026-09-22 00:00:58 +00:00
Update README contribution guidance
This commit is contained in:
okxlin
+38
-67
@@ -1,33 +1,37 @@
|
||||
[中文](https://github.com/okxlin/appstore/blob/localApps/README.md) | English
|
||||
|
||||
# 1Panel Third-Party App Store
|
||||
|
||||
Docker app configurations adapted for the `1Panel` app store `2.0`. After import, apps can be installed from the 1Panel local app store or run directly with `docker-compose` from each app version directory.
|
||||
|
||||
## Support
|
||||
|
||||
[**Support via AFDIAN**](https://afdian.com/a/dockerapps)
|
||||
|
||||
[](https://afdian.com/a/dockerapps)
|
||||
|
||||
**WeChat Reward Code**
|
||||
|
||||
<img src="docs/wechat-reward.webp" alt="WeChat reward code" width="240">
|
||||
|
||||
***
|
||||
|
||||
## Contribution Link
|
||||
|
||||
[**Click here to contribute with AFDIAN**](https://afdian.com/a/dockerapps)
|
||||
|
||||
[](https://afdian.com/a/dockerapps)
|
||||
|
||||
* * *
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Contribution Link](#contribution-link)
|
||||
- [Support](#support)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Disclaimer](#disclaimer)
|
||||
- [1. Image Container Adaptation](#1-image-container-adaptation)
|
||||
- [2. Compliance with Laws](#2-compliance-with-laws)
|
||||
- [3. Acceptance of Disclaimer](#3-acceptance-of-disclaimer)
|
||||
- [1. Introduction](#1-introduction)
|
||||
- [1Panel Third-Party App Store Categories and Introduction](#1panel-third-party-app-store-categories-and-introduction)
|
||||
- [2. Usage](#2-usage)
|
||||
- [2.1 Domestic Network](#21-domestic-network)
|
||||
- [2.1.1 Getting Apps via Git Command](#211-getting-apps-via-git-command)
|
||||
- [2.1.2 Getting Apps via Compressed Package](#212-getting-apps-via-compressed-package)
|
||||
- [2.2 International Network](#22-international-network)
|
||||
- [2.2.1 Getting Apps via Git Command](#221-getting-apps-via-git-command)
|
||||
- [2.2.2 Getting Apps via Compressed Package](#222-getting-apps-via-compressed-package)
|
||||
- [3. Remarks](#3-remarks)
|
||||
- [4. App Overview](#4-app-overview)
|
||||
- [2. Contributing Apps](#2-contributing-apps)
|
||||
- [3. Usage](#3-usage)
|
||||
- [3.1 GitHub Network Notes](#31-github-network-notes)
|
||||
- [3.2 Getting Apps via Git Command](#32-getting-apps-via-git-command)
|
||||
- [3.3 Getting Apps via Compressed Package](#33-getting-apps-via-compressed-package)
|
||||
- [4. Remarks](#4-remarks)
|
||||
- [5. App Overview](#5-app-overview)
|
||||
|
||||
|
||||
***
|
||||
@@ -51,61 +55,28 @@ Before using this repository, please ensure that you have read, understood, and
|
||||
## 1. Introduction
|
||||
These are some configurations of docker applications adapted for the `1Panel` store version 2.0.
|
||||
|
||||
Dedicated to running various Docker applications with just one click. Enjoy convenience and efficiency without complex configurations.
|
||||
This repository keeps app directories, metadata, form variables, and compose files recognizable by 1Panel so users can avoid repeated manual deployment work.
|
||||
|
||||
### 1Panel Third-Party App Store Categories and Introduction
|
||||
## 2. Contributing Apps
|
||||
|
||||
- https://1p.131.gs
|
||||
> [!IMPORTANT]
|
||||
> Before submitting an app PR, third-party developers are encouraged to generate or validate the app package with [okxlin/1panel-app-adapter](https://github.com/okxlin/1panel-app-adapter). It checks the 1Panel v2 directory layout, `data.yml`, `docker-compose.yml`, environment variable closure, i18n labels, and common release issues.
|
||||
|
||||
**Special thanks to the author [@baozishu](https://github.com/baozishu)**
|
||||
When opening a PR, include reproducible upstream sources, image sources, default ports, data directories, required dependencies, and test results. Commit only the final app directory to this repository; temporary test output and process files are not needed.
|
||||
|
||||
## 2. Usage
|
||||
## 3. Usage
|
||||
|
||||
The default installation path of `1Panel` is `/opt/`, which can be modified as needed.
|
||||
|
||||
### 2.1 Domestic Network
|
||||
### 3.1 GitHub Network Notes
|
||||
|
||||
> GitHub Acceleration Methods
|
||||
>> - (Added to this repository) Self-built: https://github.com/hunshcn/gh-proxy
|
||||
>> - https://ghp.ci
|
||||
GitHub proxy mirrors change often, so this README no longer maintains a fixed acceleration domain list. If your network cannot reach GitHub, use a trusted proxy, a self-hosted `gh-proxy`, or another acceleration method, and verify that the proxy does not modify repository content.
|
||||
|
||||
#### 2.1.1 Getting Apps via Git Command
|
||||
The examples below use official GitHub URLs. Replace them according to your proxy rules if needed.
|
||||
|
||||
In the `Shell Script` task type in the `1Panel` scheduled tasks, add and execute the following command, or run the following command in the terminal:
|
||||
### 3.2 Getting Apps via Git Command
|
||||
|
||||
```shell
|
||||
git clone -b localApps https://ghp.ci/https://github.com/okxlin/appstore /opt/1panel/resource/apps/local/appstore-localApps
|
||||
|
||||
cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/
|
||||
|
||||
rm -rf /opt/1panel/resource/apps/local/appstore-localApps
|
||||
```
|
||||
|
||||
Then refresh the local applications in the app store.
|
||||
|
||||
#### 2.1.2 Getting Apps via Compressed Package
|
||||
|
||||
In the `Shell Script` task type in the `1Panel` scheduled tasks, add and execute the following command, or run the following command in the terminal:
|
||||
|
||||
```shell
|
||||
wget -P /opt/1panel/resource/apps/local https://ghp.ci/https://github.com/okxlin/appstore/archive/refs/heads/localApps.zip
|
||||
|
||||
unzip -o -d /opt/1panel/resource/apps/local/ /opt/1panel/resource/apps/local/localApps.zip
|
||||
|
||||
cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/
|
||||
|
||||
rm -rf /opt/1panel/resource/apps/local/appstore-localApps
|
||||
|
||||
rm -rf /opt/1panel/resource/apps/local/localApps.zip
|
||||
```
|
||||
|
||||
Then refresh the local applications in the app store.
|
||||
|
||||
### 2.2 International Network
|
||||
|
||||
#### 2.2.1 Getting Apps via Git Command
|
||||
|
||||
In the `Shell Script` task type in the `1Panel` scheduled tasks, add and execute the following command, or run the following command in the terminal:
|
||||
In the `Shell Script` task type in the `1Panel` scheduled tasks, add and execute the following command, or run it in a terminal:
|
||||
|
||||
```shell
|
||||
git clone -b localApps https://github.com/okxlin/appstore /opt/1panel/resource/apps/local/appstore-localApps
|
||||
@@ -117,9 +88,9 @@ rm -rf /opt/1panel/resource/apps/local/appstore-localApps
|
||||
|
||||
Then refresh the local applications in the app store.
|
||||
|
||||
#### 2.2.2 Getting Apps via Compressed Package
|
||||
### 3.3 Getting Apps via Compressed Package
|
||||
|
||||
In the `Shell Script` task type in the `1Panel` scheduled tasks, add and execute the following command, or run the following command in the terminal:
|
||||
In the `Shell Script` task type in the `1Panel` scheduled tasks, add and execute the following command, or run it in a terminal:
|
||||
|
||||
```shell
|
||||
wget -P /opt/1panel/resource/apps/local https://github.com/okxlin/appstore/archive/refs/heads/localApps.zip
|
||||
@@ -135,7 +106,7 @@ rm -rf /opt/1panel/resource/apps/local/localApps.zip
|
||||
|
||||
Then refresh the local applications in the app store.
|
||||
|
||||
## 3. Remarks
|
||||
## 4. Remarks
|
||||
|
||||
**If an application is not displayed in the local app list, it means it has not been fully adapted for operation in the app store panel.**
|
||||
|
||||
@@ -163,6 +134,6 @@ cat ./data/hbbs/id_ed25519.pub
|
||||
|
||||
```
|
||||
|
||||
## 4. App Overview
|
||||
## 5. App Overview
|
||||
|
||||
|
||||
|
||||
@@ -1,32 +1,36 @@
|
||||
中文 | [English](https://github.com/okxlin/appstore/blob/localApps/README-en.md)
|
||||
中文 | [English](https://github.com/okxlin/appstore/blob/localApps/README-en.md)
|
||||
|
||||
# 1Panel 第三方应用商店
|
||||
|
||||
适配 `1Panel` 应用商店 `2.0` 的 Docker 应用配置合集。导入后可在 1Panel 本地应用商店中安装，也可以进入应用版本目录后用 `docker-compose` 直接运行。
|
||||
|
||||
## 支持项目
|
||||
|
||||
[**爱发电赞助：用爱发电**](https://afdian.com/a/dockerapps)
|
||||
|
||||
[](https://afdian.com/a/dockerapps)
|
||||
|
||||
**微信赞赏**
|
||||
|
||||
<img src="docs/wechat-reward.webp" alt="微信赞赏码" width="240">
|
||||
|
||||
***
|
||||
|
||||
## 打赏链接
|
||||
|
||||
[**点我打赏，用爱发电**](https://afdian.com/a/dockerapps)
|
||||
|
||||
[](https://afdian.com/a/dockerapps)
|
||||
|
||||
* * *
|
||||
## 目录
|
||||
|
||||
- [打赏链接](#打赏链接)
|
||||
- [支持项目](#支持项目)
|
||||
- [目录](#目录)
|
||||
- [免责声明](#免责声明)
|
||||
- [1. 镜像容器适配](#1-镜像容器适配)
|
||||
- [2. 法律遵守](#2-法律遵守)
|
||||
- [3. 免责声明接受](#3-免责声明接受)
|
||||
- [1. 简介](#1-简介)
|
||||
- [1Panel第三方应用商店应用分类合集与介绍](#1panel第三方应用商店应用分类合集与介绍)
|
||||
- [2. 使用方式](#2-使用方式)
|
||||
- [2.1 国内网络](#21-国内网络)
|
||||
- [2.1.1 使用 git 命令获取应用](#211-使用-git-命令获取应用)
|
||||
- [2.1.2 使用压缩包方式获取应用](#212-使用压缩包方式获取应用)
|
||||
- [2.2 国际互联网络](#22-国际互联网络)
|
||||
- [2.2.1 使用 git 命令获取应用](#221-使用-git-命令获取应用)
|
||||
- [2.2.2 使用压缩包方式获取应用](#222-使用压缩包方式获取应用)
|
||||
- [3. 备注](#3-备注)
|
||||
- [4. 应用一览图](#4-应用一览图)
|
||||
- [2. 贡献应用](#2-贡献应用)
|
||||
- [3. 使用方式](#3-使用方式)
|
||||
- [3.1 GitHub 网络说明](#31-github-网络说明)
|
||||
- [3.2 使用 git 命令获取应用](#32-使用-git-命令获取应用)
|
||||
- [3.3 使用压缩包方式获取应用](#33-使用压缩包方式获取应用)
|
||||
- [4. 备注](#4-备注)
|
||||
- [5. 应用一览图](#5-应用一览图)
|
||||
|
||||
|
||||
***
|
||||
@@ -48,59 +52,28 @@
|
||||
|
||||
***
|
||||
## 1. 简介
|
||||
这是一些适配`1Panel`商店`2.0`版本的docker应用配置。
|
||||
这是一些适配 `1Panel` 应用商店 `2.0` 的 Docker 应用配置。
|
||||
|
||||
致力于一键运行各种 Docker 应用。无需复杂配置，享受便利和高效。
|
||||
本仓库尽量保持应用目录、元数据、表单变量和 compose 配置可被 1Panel 直接识别，降低手动部署和重复配置成本。
|
||||
|
||||
### 1Panel第三方应用商店应用分类合集与介绍
|
||||
## 2. 贡献应用
|
||||
|
||||
- https://1p.131.gs
|
||||
> [!IMPORTANT]
|
||||
> 第三方开发者提交应用 PR 前，建议先使用 [okxlin/1panel-app-adapter](https://github.com/okxlin/1panel-app-adapter) 生成或校验应用包。它会检查 1Panel v2 目录结构、`data.yml`、`docker-compose.yml`、环境变量闭包、i18n 标签和常见发布问题，能减少返工。
|
||||
|
||||
**感谢作者[@包子叔](https://github.com/baozishu)**
|
||||
提交 PR 时请优先提供可复现的官方来源、镜像来源、默认端口、数据目录、前置依赖和测试结果。仓库只需要最终应用目录，不需要提交临时测试产物或过程文件。
|
||||
|
||||
## 2. 使用方式
|
||||
## 3. 使用方式
|
||||
|
||||
默认`1Panel`安装在`/opt/`路径下，如果不是按需修改以下。
|
||||
默认 `1Panel` 安装在 `/opt/` 路径下。如果你的 1Panel 安装目录不同，请按实际路径调整下面命令。
|
||||
|
||||
### 2.1 国内网络
|
||||
### 3.1 GitHub 网络说明
|
||||
|
||||
> GitHub加速方式
|
||||
>> - (本仓库已添加)自建：https://github.com/hunshcn/gh-proxy
|
||||
>> - https://ghp.ci
|
||||
GitHub 代理镜像的可用性变化很快，本 README 不再维护固定加速域名。网络受限时，可以使用可信代理、自建 `gh-proxy` 或其他加速方式，并自行确认代理没有改写仓库内容。
|
||||
|
||||
#### 2.1.1 使用 git 命令获取应用
|
||||
下面示例使用 GitHub 官方地址。如需加速，请按你使用的代理规则替换 URL。
|
||||
|
||||
`1Panel`计划任务类型`Shell 脚本`的计划任务框里，添加并执行以下命令，或者终端运行以下命令，
|
||||
```shell
|
||||
git clone -b localApps https://ghp.ci/https://github.com/okxlin/appstore /opt/1panel/resource/apps/local/appstore-localApps
|
||||
|
||||
cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/
|
||||
|
||||
rm -rf /opt/1panel/resource/apps/local/appstore-localApps
|
||||
```
|
||||
|
||||
然后应用商店刷新本地应用即可。
|
||||
|
||||
#### 2.1.2 使用压缩包方式获取应用
|
||||
|
||||
`1Panel`计划任务类型`Shell 脚本`的计划任务框里，添加并执行以下命令，或者终端运行以下命令，
|
||||
```shell
|
||||
wget -P /opt/1panel/resource/apps/local https://ghp.ci/https://github.com/okxlin/appstore/archive/refs/heads/localApps.zip
|
||||
|
||||
unzip -o -d /opt/1panel/resource/apps/local/ /opt/1panel/resource/apps/local/localApps.zip
|
||||
|
||||
cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/
|
||||
|
||||
rm -rf /opt/1panel/resource/apps/local/appstore-localApps
|
||||
|
||||
rm -rf /opt/1panel/resource/apps/local/localApps.zip
|
||||
```
|
||||
|
||||
然后应用商店刷新本地应用即可。
|
||||
|
||||
### 2.2 国际互联网络
|
||||
|
||||
#### 2.2.1 使用 git 命令获取应用
|
||||
### 3.2 使用 git 命令获取应用
|
||||
|
||||
`1Panel`计划任务类型`Shell 脚本`的计划任务框里，添加并执行以下命令，或者终端运行以下命令，
|
||||
```shell
|
||||
@@ -113,7 +86,7 @@ rm -rf /opt/1panel/resource/apps/local/appstore-localApps
|
||||
|
||||
然后应用商店刷新本地应用即可。
|
||||
|
||||
#### 2.2.2 使用压缩包方式获取应用
|
||||
### 3.3 使用压缩包方式获取应用
|
||||
|
||||
`1Panel`计划任务类型`Shell 脚本`的计划任务框里，添加并执行以下命令，或者终端运行以下命令，
|
||||
```shell
|
||||
@@ -131,7 +104,7 @@ rm -rf /opt/1panel/resource/apps/local/localApps.zip
|
||||
然后应用商店刷新本地应用即可。
|
||||
|
||||
|
||||
## 3. 备注
|
||||
## 4. 备注
|
||||
|
||||
**未显示在本地应用列表里的，表示未完全适配应用商店面板操作**
|
||||
|
||||
@@ -159,6 +132,6 @@ cat ./data/hbbs/id_ed25519.pub
|
||||
|
||||
```
|
||||
|
||||
## 4. 应用一览图
|
||||
## 5. 应用一览图
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Reference in New Issue
Block a user