renil/lx-music-api-server
1
0
Fork 0
mirror of https://github.com/MeoProject/lx-music-api-server.git synced 2025-05-23 19:17:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: 更新README

Browse Source
This commit is contained in:
Folltoshe 2023-12-02 11:11:00 +08:00
parent ada4b5ff8f
commit 37b1349e38
1 changed files with 44 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -2,24 +2,24 @@
![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)
</div>
原仓库：[lx-music-api-server](https://github.com/lxmusics/lx-music-api-server)
您可以在原仓库中找到对应的可用源脚本
你可以在原仓库中找到对应的可用源脚本
## 还在开发中
**由于使用此项目导致的封号等情况与本项目无关**
**主开发是高一住校学生，只有周末有时间回复，也欢迎所有人来贡献代码，我们在这里万分感谢**
## 使用此项目导致的封号等情况与开发者无关
## 部署方法
## 手动部署方法
### 直接部署
环境要求：Python 3.8+
没有其他限制，能用 Python 理论上就能跑起来
@ -34,26 +34,34 @@ python main.py # 启动服务
对于 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 | 获取失败 |
@ -64,7 +72,7 @@ docker run -p 9763:9763 -d ikun0014/lx-music-api-server-python:latest
接口返回的`statuscode`对应的代码含义
| 内容 | 含义 |
|------|-----------------------------------|
| ---- | ---------------------------------- |
| 200 | 成功 |
| 403 | IP 被封禁 |
| 400 | 参数错误 |