From 37b1349e38c5c7d2ee038d9744ce5ef401decfeb Mon Sep 17 00:00:00 2001 From: Folltoshe Date: Sat, 2 Dec 2023 11:11:00 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 80 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 44 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 005f3d4..988c6e7 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,29 @@ ![lx-music-api-server-python](https://socialify.git.ci/lxmusics/lx-music-api-server-python/image?description=1&font=Inter&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&stargazers=1&theme=Auto) -![GitHub repo size](https://img.shields.io/github/repo-size/lxmusics/lx-music-api-server-python?style=for-the-badge) +![GitHub Repo Size](https://img.shields.io/github/repo-size/lxmusics/lx-music-api-server-python?style=for-the-badge) [![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/lxmusics/lx-music-api-server-python/build_binary.yml?style=for-the-badge)](https://github.com/lxmusics/lx-music-api-server-python/actions/workflows/build_binary.yml) -[![GitHub release (with filter)](https://img.shields.io/github/v/release/lxmusics/lx-music-api-server-python?style=for-the-badge)](https://github.com/lxmusics/lx-music-api-server-python/releases) -[![GitHub all releases](https://img.shields.io/github/downloads/lxmusics/lx-music-api-server-python/total?style=for-the-badge&color=violet)](https://github.com/lxmusics/lx-music-api-server-python/releases) -[![GitHub License](https://img.shields.io/github/license/lxmusics/lx-music-api-server-python?style=for-the-badge) -]((https://github.com/lxmusics/lx-music-api-server/blob/main/LICENSE)) +[![GitHub Release (with filter)](https://img.shields.io/github/v/release/lxmusics/lx-music-api-server-python?style=for-the-badge)](https://github.com/lxmusics/lx-music-api-server-python/releases) +[![GitHub All Releases](https://img.shields.io/github/downloads/lxmusics/lx-music-api-server-python/total?style=for-the-badge&color=violet)](https://github.com/lxmusics/lx-music-api-server-python/releases) +[![GitHub License](https://img.shields.io/github/license/lxmusics/lx-music-api-server-python?style=for-the-badge)](https://github.com/lxmusics/lx-music-api-server/blob/main/LICENSE) + 原仓库：[lx-music-api-server](https://github.com/lxmusics/lx-music-api-server) -您可以在原仓库中找到对应的可用源脚本 +你可以在原仓库中找到对应的可用源脚本 -## 还在开发中 +**由于使用此项目导致的封号等情况与本项目无关** **主开发是高一住校学生，只有周末有时间回复，也欢迎所有人来贡献代码，我们在这里万分感谢** -## 使用此项目导致的封号等情况与开发者无关 +## 部署方法 -## 手动部署方法 +### 直接部署 -环境要求：Python 3.8+ -没有其他限制，能用Python理论上就能跑起来 +环境要求：Python 3.8+ +没有其他限制，能用 Python 理论上就能跑起来 -测试版本部署，linux命令如果为python3请自行替换： +测试版本部署，linux 命令如果为 python3 请自行替换： ```bash git clone https://github.com/lxmusics/lx-music-api-server-python.git # clone本项目 @@ -32,53 +32,61 @@ python -m pip install -r ./requirements.txt # 安装依赖 python main.py # 启动服务 ``` -对于release的部署和上方类似，这里不再赘述 +对于 release 的部署和上方类似，这里不再赘述 -## Docker部署（目录映射搞不懂，最好有个宝塔面板啥的） +### Docker 部署 -环境要求:Docker -最低版本要求不知道，最新的bug会少知道这就行 +环境要求：Docker + +**该方法未经测试，不知道需要的 Docker 版本，可以自己尝试现有的 Docker 版本是否可以使用** ```bash +# 更新软件包 sudo apt-get update + +# 安装Docker，已有跳过 sudo apt-get install -y docker.io -docker run -p 9763:9763 -d ikun0014/lx-music-api-server-python:latest + +# 创建容器 +docker run --name lx-music-api-server-python -p 9763:9763 -d ikun0014/lx-music-api-server-python:latest + +# 获取容器目录 +docker inspect lx-music-api-server-python ``` -配置文件填写需要到容器目录里的/app目录填写config.json -小小白还是回去手动部署得了 +**配置文件填写需要到容器目录里的 /app 目录填写 config.json** ## 返回码说明 接口返回值中`body.code`字段值中的代码含义 -| 内容 | 含义 | -|------|--------------------------------------| -| 0 |成功 | -| 1 |IP被封禁 | -| 2 |获取失败 | -| 4 |服务器内部错误（对应statuscode 500） | -| 5 |请求过于频繁 | -| 6 |参数错误 | +| 内容 | 含义 | +| ---- | ------------------------------------- | +| 0 | 成功 | +| 1 | IP 被封禁 | +| 2 | 获取失败 | +| 4 | 服务器内部错误（对应 statuscode 500） | +| 5 | 请求过于频繁 | +| 6 | 参数错误 | 接口返回的`statuscode`对应的代码含义 -| 内容 | 含义 | -|------|-----------------------------------| -| 200 |成功 | -| 403 |IP被封禁 | -| 400 |参数错误 | -| 429 |请求过于频繁 | -| 500 |服务器内部错误（对应body.code 4） | +| 内容 | 含义 | +| ---- | ---------------------------------- | +| 200 | 成功 | +| 403 | IP 被封禁 | +| 400 | 参数错误 | +| 429 | 请求过于频繁 | +| 500 | 服务器内部错误（对应 body.code 4） | ## 项目协议 -本项目基于 [MIT](https://github.com/lxmusics/lx-music-api-server/blob/main/LICENSE) 许可证发行，以下协议是对于MIT原协议的补充，如有冲突，以以下协议为准。 +本项目基于 [MIT](https://github.com/lxmusics/lx-music-api-server/blob/main/LICENSE) 许可证发行，以下协议是对于 MIT 原协议的补充，如有冲突，以以下协议为准。 词语约定：本协议中的“本项目”指本音源项目；“使用者”指签署本协议的使用者；“官方音乐平台”指对本项目内置的包括酷我、酷狗、咪咕等音乐源的官方平台统称；“版权数据”指包括但不限于图像、音频、名字等在内的他人拥有所属版权的数据。 1. 本项目的数据来源原理是从各官方音乐平台的公开服务器中拉取数据，经过对数据简单地筛选与合并后进行展示，因此本项目不对数据的准确性负责。 -2. 使用本项目的过程中可能会产生版权数据，对于这些版权数据，本项目不拥有它们的所有权，为了避免造成侵权，使用者务必在**24小时**内清除使用本项目的过程中所产生的版权数据。 +2. 使用本项目的过程中可能会产生版权数据，对于这些版权数据，本项目不拥有它们的所有权，为了避免造成侵权，使用者务必在**24 小时**内清除使用本项目的过程中所产生的版权数据。 3. 由于使用本项目产生的包括由于本协议或由于使用或无法使用本项目而引起的任何性质的任何直接、间接、特殊、偶然或结果性损害（包括但不限于因商誉损失、停工、计算机故障或故障引起的损害赔偿，或任何及所有其他商业损害或损失）由使用者负责。 4. 本项目完全免费，且开源发布于 GitHub 面向全世界人用作对技术的学习交流，本项目不对项目内的技术可能存在违反当地法律法规的行为作保证，**禁止在违反当地法律法规的情况下使用本项目**，对于使用者在明知或不知当地法律法规不允许的情况下使用本项目所造成的任何违法违规行为由使用者承担，本项目不承担由此造成的任何直接、间接、特殊、偶然或结果性责任。