Update and rename README_zh.md to README-zh-cn.md
This commit is contained in:
1 parent
cb719d8c69
commit
018256530c
2 files changed
+176
-207
No files matched your search
+176
@@ -0,0 +1,176 @@
|
||||
# XPack(全球首个开源 MCP 交易平台)
|
||||
|
||||

|
||||
|
||||
<p align="center">
|
||||
<a href="/README.md">English</a>
|
||||
|
|
||||
<a href="/README-zh-cn.md">简体中文</a>
|
||||
</p>
|
||||
|
||||
**XPack** 是一款轻量级、开源的 MCP(Model Context Protocol)服务市场框架。
|
||||
它可以将任何符合 OpenAPI 规范的接口快速转换为 MCP 服务,并帮助你在数分钟内搭建自己的 API 商店。
|
||||
|
||||
<br>
|
||||
|
||||
✨ 使用 XPack,你可以:
|
||||
- ✅ **一键将 OpenAPI 转换为 MCP 服务配置**
|
||||
- 🧾 **自动生成 SEO 友好的主页和服务页**
|
||||
- 💳 **内置调用计费功能(支持按次收费)**
|
||||
- 👥 **用户账户体系与管理后台**
|
||||
- 🛠 **内置 Stripe 支付集成**
|
||||
- 🔐 **支持邮箱 & Google 登录认证**
|
||||
|
||||
本项目基于 **Apache 2.0 协议开源**,可放心用于商业用途。
|
||||
|
||||
<br>
|
||||
|
||||
# ✨ 快速开始
|
||||
|
||||
😍 只需一行命令,即可在 10 分钟内部署你的 MCP 服务市场:
|
||||
|
||||
```bash
|
||||
curl -sSO http://xpack.ai/install/quick-start.sh; bash quick-start.sh
|
||||
```
|
||||
|
||||
该脚本会自动安装 MySQL、Redis、RabbitMQ,并启动 XPack 服务。
|
||||
|
||||
<br>
|
||||
|
||||
# 📸 功能截图
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
<br>
|
||||
|
||||
## 🖥️ 系统要求
|
||||
|
||||
### ✅ 推荐配置
|
||||
- **CPU**: 8 核
|
||||
- **内存**: 16 GB
|
||||
- **硬盘**: 200 GB
|
||||
- **操作系统**: Linux
|
||||
- **架构**: AMD64
|
||||
|
||||
### ✅ 最低配置
|
||||
- **CPU**: 2 核
|
||||
- **内存**: 4 GB
|
||||
- **硬盘**: 200 GB
|
||||
- **操作系统**: Linux / macOS
|
||||
- **架构**: AMD64 / ARM64
|
||||
|
||||
<br>
|
||||
|
||||
## 📦 运行依赖
|
||||
|
||||
XPack-MCP-Market 依赖以下服务(可容器化或自行安装):
|
||||
|
||||
| 组件 | 最低版本 |
|
||||
|-------------|------------|
|
||||
| **MySQL** | ≥ 5.7.x |
|
||||
| **Redis** | ≥ 6.2.x |
|
||||
| **RabbitMQ**| ≥ 4.0 |
|
||||
|
||||
请确保这些服务已正常运行并配置好连接参数。
|
||||
|
||||
<br>
|
||||
|
||||
## 💿 部署方式
|
||||
|
||||
### 🟢 快速部署命令
|
||||
|
||||
```bash
|
||||
curl -sSO http://xpack.ai/install/quick-start.sh; bash quick-start.sh
|
||||
```
|
||||
|
||||
支持系统包括:
|
||||
- CentOS 7.9 / 8.5
|
||||
- Ubuntu 20.04 / 22.04
|
||||
- Debian 12.4
|
||||
- 阿里云 Linux 2.1903 / 3.2104
|
||||
|
||||
如需支持其他系统,请在 [Issues](https://github.com/xpack-ai/XPack-MCP-Market/issues) 提交反馈。
|
||||
|
||||
---
|
||||
|
||||
<details>
|
||||
<summary><h4>🔖Docker-Compose 部署</h4></summary>
|
||||
|
||||
安装 Docker 和 Docker Compose 后:
|
||||
|
||||
1. 编辑 `docker-compose.yml`
|
||||
```bash
|
||||
vi docker-compose.yml
|
||||
```
|
||||
|
||||
2. 修改配置,可参考 [示例配置](https://github.com/xpack-ai/XPack-MCP-Market/blob/main/scripts/docker-compose.yml)
|
||||
|
||||
3. 启动服务:
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
4. 打开浏览器访问 `http://localhost:3000` 使用平台
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><h4>🔖源码构建</h4></summary>
|
||||
|
||||
### 克隆仓库
|
||||
|
||||
```bash
|
||||
git clone https://github.com/xpack-ai/XPack-MCP-Market.git
|
||||
cd XPack-MCP-Market
|
||||
```
|
||||
|
||||
### ✅ 前端构建(需 Node ≥22,pnpm ≥10)
|
||||
|
||||
```bash
|
||||
cd scripts && ./frontend_build.sh && cd ../
|
||||
cd frontend/out && node server.js
|
||||
```
|
||||
|
||||
### ✅ 后端构建(需 Python ≥ 3.11)
|
||||
|
||||
推荐使用 [`uv`](https://github.com/astral-sh/uv)
|
||||
|
||||
```bash
|
||||
uv venv
|
||||
source .venv/bin/activate
|
||||
uv pip install -r requirements.txt
|
||||
cp .env.example .env
|
||||
vi .env
|
||||
```
|
||||
|
||||
启动服务:
|
||||
|
||||
- 管理后台(端口 8001)
|
||||
```bash
|
||||
uvicorn services.admin_service.main:app --host 0.0.0.0 --port 8001 --reload
|
||||
```
|
||||
|
||||
- MCP 服务接口(端口 8002)
|
||||
```bash
|
||||
uvicorn services.api_service.main:app --host 0.0.0.0 --port 8002 --reload
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
# 🧾 开源协议
|
||||
|
||||
XPack-MCP-Market 遵循 [Apache 2.0 License](./LICENSE),支持商业用途与二次开发。
|
||||
|
||||
<br>
|
||||
|
||||
# 💌 联系我们
|
||||
|
||||
- 官网: [https://xpack.ai](https://xpack.ai)
|
||||
- 邮箱: [contact@xpack.com](mailto:contact@xpack.com)
|
||||
|
||||
<br>
|
||||
-207
@@ -1,207 +0,0 @@
|
||||
# XPack-MCP-Market
|
||||

|
||||
|
||||
## 硬件要求
|
||||
**推荐配置**
|
||||
- CPU:8核
|
||||
- 内存:16G
|
||||
- 硬盘存储:200G
|
||||
- 操作系统:Linux
|
||||
- 系统架构:AMD64
|
||||
|
||||
**最低配置**
|
||||
- CPU:2核
|
||||
- 内存:4G
|
||||
- 硬盘存储:200G
|
||||
- 操作系统:Linux / Mac
|
||||
- 系统架构:AMD64 / ARM64
|
||||
|
||||
**程序依赖**
|
||||
**XPack** 依赖 `MySQL、Redis、RabbitMQ`,所需版本如下:
|
||||
- **MySQL:** >= 5.7.x
|
||||
- **Redis:** >= 6.2.x
|
||||
- **RabbitMQ:** >= 4.0
|
||||
|
||||
## 部署
|
||||
### 脚本一键部署
|
||||
> 支持的系统列表:
|
||||
> - CentOS 7.9(7.x为代表)
|
||||
> - CentOS 8.5(8.x为代表)
|
||||
> - Ubuntu 20.04
|
||||
> - Ubuntu 22.04
|
||||
> - Debian 12.4
|
||||
> - Alibaba Cloud Linux 3.2104
|
||||
> - Alibaba Cloud Linux 2.1903
|
||||
|
||||
当前仅测试了上述部署的安装,若需要其他系统的一键部署,可给我们提交[Issue](https://github.com/xpack-ai/XPack-MCP-Market/issues)。
|
||||
```bash
|
||||
curl -sSO https://download.xpack.com/install/quick-start.sh; bash quick-start.sh
|
||||
```
|
||||
|
||||
### Docker-Compose部署
|
||||
使用此方法安装 **XPack-MCP-Market**,你需要安装 [Docker](https://docs.docker.com/engine/install/) 和 [Docker Compose](https://docs.docker.com/compose/install/standalone/)。
|
||||
|
||||
1. 编辑 `docker-compose.yml` 文件
|
||||
```bash
|
||||
vi docker-compose.yml
|
||||
```
|
||||
|
||||
2. 修改文件配置,原文件可参考 [docker-compose.yml](https://github.com/xpack-ai/XPack-MCP-Market/blob/main/scripts/docker-compose.yml)
|
||||
```yaml
|
||||
version: '3'
|
||||
services:
|
||||
xpack-mysql:
|
||||
image: mysql:8.0.37
|
||||
privileged: true
|
||||
restart: always
|
||||
container_name: xpack-mysql
|
||||
hostname: xpack-mysql
|
||||
command:
|
||||
- "--character-set-server=utf8mb4"
|
||||
- "--collation-server=utf8mb4_unicode_ci"
|
||||
ports:
|
||||
- "33306:3306"
|
||||
environment:
|
||||
- MYSQL_ROOT_PASSWORD=mysql_ZTdhRB
|
||||
- MYSQL_DATABASE=xpack
|
||||
volumes:
|
||||
- /var/lib/xpack/mysql:/var/lib/mysql
|
||||
networks:
|
||||
- xpack
|
||||
xpack-mcp-market:
|
||||
image: xpackai/xpack-mcp-market
|
||||
container_name: xpack-mcp-market
|
||||
privileged: true
|
||||
restart: always
|
||||
networks:
|
||||
- xpack
|
||||
ports:
|
||||
- "3000:3000"
|
||||
- "8002:8002"
|
||||
depends_on:
|
||||
- xpack-mysql
|
||||
- xpack-redis
|
||||
- xpack-rabbitmq
|
||||
xpack-redis:
|
||||
container_name: xpack-redis
|
||||
image: redis:7.2.4
|
||||
hostname: xpack-redis
|
||||
privileged: true
|
||||
restart: always
|
||||
ports:
|
||||
- 6379:6379
|
||||
command:
|
||||
- bash
|
||||
- -c
|
||||
- "redis-server --protected-mode yes --logfile redis.log --appendonly no --port 6379 --requirepass redis_6sJZDm"
|
||||
networks:
|
||||
- xpack
|
||||
xpack-rabbitmq:
|
||||
image: rabbitmq:4.1.2-alpine
|
||||
container_name: xpack-rabbitmq
|
||||
privileged: true
|
||||
restart: always
|
||||
environment:
|
||||
- RABBITMQ_DEFAULT_USER=rabbitmq
|
||||
- RABBITMQ_DEFAULT_PASS=rabbitmq_Gs123dA
|
||||
networks:
|
||||
- xpack
|
||||
networks:
|
||||
xpack:
|
||||
driver: bridge
|
||||
ipam:
|
||||
driver: default
|
||||
config:
|
||||
- subnet: 172.101.0.0/24
|
||||
```
|
||||
|
||||
3. 启动XPack-MCP-Market
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
4. 浏览器访问XPack-MCP-Market,端口号默认为:3000
|
||||
|
||||
|
||||
## 编译指南
|
||||
### 前期准备
|
||||
1. 拉取XPack-MCP-Market仓库
|
||||
```bash
|
||||
git clone https://github.com/xpack-ai/XPack-MCP-Market.git
|
||||
```
|
||||
|
||||
2. 进入项目目录
|
||||
```bash
|
||||
cd XPack-MCP-Market
|
||||
```
|
||||
|
||||
### 编译前端
|
||||
> 环境要求:
|
||||
> - Node >= 22.x
|
||||
> - Pnpm >= 10.x
|
||||
|
||||
1. 执行前端编译脚本
|
||||
```bash
|
||||
cd scripts && ./frontend_build.sh && cd ../
|
||||
```
|
||||
编译完成后,前端代码将编译进 `frontend/out` 目录。
|
||||
|
||||
2. 启动UI界面
|
||||
```bash
|
||||
cd frontend/out && node server.js
|
||||
```
|
||||
|
||||
### 编译后端
|
||||
> 环境要求:
|
||||
> - Python >= 3.11
|
||||
|
||||
#### 使用 `uv`(推荐)
|
||||
1. 创建虚拟环境
|
||||
```bash
|
||||
uv venv
|
||||
```
|
||||
|
||||
2. 激活虚拟环境
|
||||
```bash
|
||||
source .venv/bin/activate
|
||||
```
|
||||
|
||||
3. 安装依赖
|
||||
```bash
|
||||
uv pip install -r requirements.txt
|
||||
```
|
||||
|
||||
4. 复制环境变量文件
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
5. 编辑环境变量
|
||||
```bash
|
||||
vi .env
|
||||
```
|
||||
|
||||
6. 启动管理后台服务
|
||||
**前台运行**
|
||||
```bash
|
||||
uvicorn services.admin_service.main:app --host 0.0.0.0 --port 8001 --reload
|
||||
```
|
||||
**后台运行**
|
||||
```bash
|
||||
uvicorn services.admin_service.main:app --host 0.0.0.0 --port 8001 --reload &
|
||||
```
|
||||
|
||||
7. 启动API转MCP服务
|
||||
**前台运行**
|
||||
```bash
|
||||
uvicorn services.api_service.main:app --host 0.0.0.0 --port 8002 --reload
|
||||
```
|
||||
**后台运行**
|
||||
```bash
|
||||
uvicorn services.api_service.main:app --host 0.0.0.0 --port 8002 --reload &
|
||||
```
|
||||
|
||||
### Docker编译
|
||||
```bash
|
||||
docker build -t xpack --build-arg APP=xpack --build-arg VERSION=1.0.0 -f ./scripts/Dockerfile ./
|
||||
```
|
||||
Reference in new issue
Block a user