From 39ac4ca90fd26cde5d5738e9e6d0409e232fdba1 Mon Sep 17 00:00:00 2001 From: okxlin Date: Mon, 22 Jan 2024 15:58:26 +0800 Subject: [PATCH] =?UTF-8?q?feat:=E6=9B=B4=E6=96=B0README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README-en.md | 167 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 17 +++--- 2 files changed, 176 insertions(+), 8 deletions(-) create mode 100644 README-en.md diff --git a/README-en.md b/README-en.md new file mode 100644 index 00000000..1a616393 --- /dev/null +++ b/README-en.md @@ -0,0 +1,167 @@ +[中文](https://github.com/okxlin/appstore/blob/localApps/README.md) | English +*** + +## Contribution Link + +[**Click here to contribute with AFDIAN**](https://afdian.net/a/dockerapps) + +[![**Click here to contribute with AFDIAN**](https://github.com/okxlin/appstore/raw/localApps/docs/afdian-logo.png)](https://afdian.net/a/dockerapps) + +* * * + +## Table of Contents + +- [Contribution Link](#contribution-link) +- [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) + + +*** + +## Disclaimer + +### 1. Image Container Adaptation +This project specifically adapts to the `1Panel` app store for original `docker` image container operations. We do not make any explicit or implicit warranties or statements regarding the validity of any original images, and we are not responsible for any effects caused by using applications from this repository. Users undertake the risks associated with using this project on their own. + +### 2. Compliance with Laws +When using this repository, users must comply with the laws and regulations of their respective countries and regions. Certain applications may be restricted by specific national laws, and users need to understand and comply with relevant legal requirements. This repository is not responsible for any consequences arising from the user's violation of laws and regulations. + +### 3. Acceptance of Disclaimer +By importing and using the applications in this repository, the user signifies that they have read, understood, and accepted all the terms and conditions of this disclaimer. + +Please note that this disclaimer applies only to the use of this repository and does not encompass other third-party applications or services. We are not responsible for the accuracy, completeness, reliability, or legality of third-party content linked to this repository. + +Before using this repository, please ensure that you have read, understood, and accepted all the terms and conditions of this disclaimer. + +*** +## 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. + +### 1Panel Third-Party App Store Categories and Introduction + +- https://1p.131.gs + +**Special thanks to the author [@baozishu](https://github.com/baozishu)** + +## 2. Usage + +The default installation path of `1Panel` is `/opt/`, which can be modified as needed. + +### 2.1 Domestic Network + +> GitHub Acceleration Methods +>> - (Added to this repository) Self-built: https://github.com/hunshcn/gh-proxy +>> - https://mirror.ghproxy.com + +#### 2.1.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: + +```shell +git clone -b localApps https://mirror.ghproxy.com/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://mirror.ghproxy.com/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: + +```shell +git clone -b localApps 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.2.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://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. + +## 3. 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.** + +**However, it can still be run directly in the terminal.** + +> Most applications in this repository support running directly with `docker-compose up` + +Taking `rustdesk` as an example: + +```shell +# Enter the latest version directory of rustdesk +cd /opt/1panel/resource/apps/local/rustdesk/versions/latest/ + +# Copy .env.sample as .env +cp .env.sample .env + +# Edit the .env file and modify the parameters +nano .env + +# Start RustDesk +docker-compose up -d + +# View the necessary key for connecting +cat ./data/hbbs/id_ed25519.pub + +``` + +## 4. App Overview + +![](https://github.com/okxlin/appstore/raw/localApps/docs/app-list.png) \ No newline at end of file diff --git a/README.md b/README.md index 60c9cbd3..ea13a6ee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ + 中文 | [English](https://github.com/okxlin/appstore/blob/localApps/README-en.md) +*** + ## 打赏链接 [**点我打赏，用爱发电**](https://afdian.net/a/dockerapps) @@ -8,7 +11,6 @@ ## 目录 - [打赏链接](#打赏链接) -- [目录](#目录) - [免责声明](#免责声明) - [1. 镜像容器适配](#1-镜像容器适配) - [2. 法律遵守](#2-法律遵守) @@ -63,7 +65,6 @@ > GitHub加速方式 >> - (本仓库已添加)自建：https://github.com/hunshcn/gh-proxy ->> - ~~https://ghproxy.com~~ >> - https://mirror.ghproxy.com #### 2.1.1 使用 git 命令获取应用 @@ -74,7 +75,7 @@ git clone -b localApps https://mirror.ghproxy.com/https://github.com/okxlin/apps cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/ -rm -r /opt/1panel/resource/apps/local/appstore-localApps +rm -rf /opt/1panel/resource/apps/local/appstore-localApps ``` 然后应用商店刷新本地应用即可。 @@ -89,9 +90,9 @@ unzip -o -d /opt/1panel/resource/apps/local/ /opt/1panel/resource/apps/local/loc cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/ -rm -r /opt/1panel/resource/apps/local/appstore-localApps +rm -rf /opt/1panel/resource/apps/local/appstore-localApps -rm /opt/1panel/resource/apps/local/localApps.zip +rm -rf /opt/1panel/resource/apps/local/localApps.zip ``` 然后应用商店刷新本地应用即可。 @@ -106,7 +107,7 @@ git clone -b localApps https://github.com/okxlin/appstore /opt/1panel/resource/a cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/ -rm -r /opt/1panel/resource/apps/local/appstore-localApps +rm -rf /opt/1panel/resource/apps/local/appstore-localApps ``` 然后应用商店刷新本地应用即可。 @@ -121,9 +122,9 @@ unzip -o -d /opt/1panel/resource/apps/local/ /opt/1panel/resource/apps/local/loc cp -rf /opt/1panel/resource/apps/local/appstore-localApps/apps/* /opt/1panel/resource/apps/local/ -rm -r /opt/1panel/resource/apps/local/appstore-localApps +rm -rf /opt/1panel/resource/apps/local/appstore-localApps -rm /opt/1panel/resource/apps/local/localApps.zip +rm -rf /opt/1panel/resource/apps/local/localApps.zip ``` 然后应用商店刷新本地应用即可。