docs: update README and docker-compose to use Docker Hub images
- Add Docker deployment section with quick start guide - Update docker-compose.yml to use pre-built images from Docker Hub - Add Docker Pulls badge to README - Reorganize quick start to show Docker first (recommended method) Made-with: Cursor
This commit is contained in:
parent
35f0fb7c0b
commit
a8de1961db
48
README.md
48
README.md
|
|
@ -8,6 +8,7 @@
|
||||||
|
|
||||||
[](https://github.com/tmwgsicp/wechat-download-api/stargazers)
|
[](https://github.com/tmwgsicp/wechat-download-api/stargazers)
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
|
[](https://hub.docker.com/r/tmwgsicp/wechat-download-api)
|
||||||
[](https://www.python.org/)
|
[](https://www.python.org/)
|
||||||
[](https://fastapi.tiangolo.com/)
|
[](https://fastapi.tiangolo.com/)
|
||||||
|
|
||||||
|
|
@ -39,6 +40,33 @@
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Docker 部署 🐳
|
||||||
|
|
||||||
|
**最快速的部署方式**,无需配置 Python 环境,一键启动:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 方式一:使用 docker-compose(推荐)
|
||||||
|
git clone https://github.com/tmwgsicp/wechat-download-api.git
|
||||||
|
cd wechat-download-api
|
||||||
|
cp env.example .env
|
||||||
|
# 编辑 .env 设置 SITE_URL 为实际访问地址
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
|
# 方式二:直接运行
|
||||||
|
docker run -d \
|
||||||
|
-p 5000:5000 \
|
||||||
|
-v $(pwd)/data:/app/data \
|
||||||
|
-v $(pwd)/.env:/app/.env \
|
||||||
|
--name wechat-api \
|
||||||
|
tmwgsicp/wechat-download-api:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
服务启动后访问 `http://localhost:5000/login.html` 扫码登录即可使用。
|
||||||
|
|
||||||
|
**支持多架构**:`linux/amd64` / `linux/arm64`(Apple Silicon、树莓派、ARM 服务器)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## SaaS 托管版 — 已上线 🚀
|
## SaaS 托管版 — 已上线 🚀
|
||||||
|
|
||||||
**不想折腾部署?30 秒注册即可使用** 👉 **[wechatrss.waytomaster.com](https://wechatrss.waytomaster.com)**
|
**不想折腾部署?30 秒注册即可使用** 👉 **[wechatrss.waytomaster.com](https://wechatrss.waytomaster.com)**
|
||||||
|
|
@ -71,6 +99,26 @@
|
||||||
|
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
|
### 方式一:Docker 部署(推荐)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 克隆项目
|
||||||
|
git clone https://github.com/tmwgsicp/wechat-download-api.git
|
||||||
|
cd wechat-download-api
|
||||||
|
|
||||||
|
# 2. 配置环境变量
|
||||||
|
cp env.example .env
|
||||||
|
# 编辑 .env,设置 SITE_URL 为实际访问地址(如 http://your-domain.com)
|
||||||
|
|
||||||
|
# 3. 启动服务
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
|
# 4. 查看日志
|
||||||
|
docker-compose logs -f
|
||||||
|
```
|
||||||
|
|
||||||
|
### 方式二:一键脚本部署
|
||||||
|
|
||||||
**第一步:克隆项目**
|
**第一步:克隆项目**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
||||||
|
|
@ -9,9 +9,9 @@
|
||||||
|
|
||||||
services:
|
services:
|
||||||
wechat-api:
|
wechat-api:
|
||||||
build: .
|
image: tmwgsicp/wechat-download-api:latest
|
||||||
# Or use pre-built image (after published):
|
# Or build locally:
|
||||||
# image: tmwgsicp/wechat-download-api:latest
|
# build: .
|
||||||
container_name: wechat-download-api
|
container_name: wechat-download-api
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
ports:
|
ports:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue