mirror of
https://github.com/nickrunning/wechat-selkies.git
synced 2026-05-09 00:24:09 +00:00
docs: update README and minor fix
This commit is contained in:
10
.github/workflows/docker.yml
vendored
10
.github/workflows/docker.yml
vendored
@@ -117,25 +117,27 @@ jobs:
|
||||
|
||||
**GitHub Container Registry:**
|
||||
```bash
|
||||
docker pull ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}
|
||||
docker pull ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.meta.outputs.version }}
|
||||
docker pull ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
|
||||
```
|
||||
|
||||
**Docker Hub** (if enabled):
|
||||
```bash
|
||||
docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:${{ github.ref_name }}
|
||||
docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:${{ steps.meta.outputs.version }}
|
||||
docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:latest
|
||||
```
|
||||
|
||||
## 🚀 Quick Start
|
||||
**GitHub Container Registry:**
|
||||
```bash
|
||||
docker run -it -p 3001:3001 -v ./config:/config ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.meta.outputs.version }}
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
|
||||
```
|
||||
|
||||
**Docker Hub** (if enabled):
|
||||
```bash
|
||||
docker run -it -p 3001:3001 -v ./config:/config ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:${{ github.ref_name }}
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:${{ steps.meta.outputs.version }}
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:latest
|
||||
```
|
||||
|
||||
Then visit: https://localhost:3001
|
||||
13
README.md
13
README.md
@@ -35,6 +35,10 @@
|
||||
- 🪟 **窗口切换器**:左上角增加切换悬浮窗,方便切换到后台窗口,为后续添加其它功能做基础
|
||||
- 🤖 **自动启动**:可配置自动启动微信和QQ客户端(可选)
|
||||
|
||||
## 截图展示
|
||||

|
||||

|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
@@ -49,17 +53,18 @@
|
||||
|
||||
GitHub Container Registry镜像:
|
||||
```bash
|
||||
docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selkies:latest
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ghcr.io/nickrunning/wechat-selkies:latest
|
||||
```
|
||||
|
||||
Docker Hub镜像:
|
||||
```bash
|
||||
docker run -it -p 3001:3001 -v ./config:/config nickrunning/wechat-selkies:latest
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri nickrunning/wechat-selkies:latest
|
||||
```
|
||||
|
||||
2. **访问微信**
|
||||
|
||||
在浏览器中访问:`https://localhost:3001` 或 `https://<服务器IP>:3001`
|
||||
> **注意:** 映射3000端口用于HTTP访问,3001端口用于HTTPS访问,建议使用HTTPS。
|
||||
|
||||
### docker-compose 部署
|
||||
1. **创建项目目录并进入**
|
||||
@@ -74,7 +79,9 @@ docker run -it -p 3001:3001 -v ./config:/config nickrunning/wechat-selkies:lates
|
||||
image: nickrunning/wechat-selkies:latest # or ghcr.io/nickrunning/wechat-selkies:latest
|
||||
container_name: wechat-selkies
|
||||
ports:
|
||||
- "3001:3001"
|
||||
- "3000:3000" # http port
|
||||
- "3001:3001" # https port
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- ./config:/config
|
||||
devices:
|
||||
|
||||
13
README_en.md
13
README_en.md
@@ -34,6 +34,10 @@ This project packages the official WeChat/QQ Linux client in a Docker container,
|
||||
- 🔧 **Hardware Acceleration**: Optional GPU hardware acceleration support
|
||||
- 🪟 **Window Switcher**: Added a floating window switcher in the top left corner for easy switching to background windows, laying the foundation for adding other features in the future
|
||||
|
||||
## Screenshots
|
||||

|
||||

|
||||
|
||||
## Quick Start
|
||||
|
||||
### Requirements
|
||||
@@ -47,16 +51,17 @@ This project packages the official WeChat/QQ Linux client in a Docker container,
|
||||
1. **Direct deployment using pre-built images**
|
||||
GitHub Container Registry image:
|
||||
```bash
|
||||
docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selkies:latest
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ghcr.io/nickrunning/wechat-selkies:latest
|
||||
```
|
||||
Docker Hub image:
|
||||
```bash
|
||||
docker run -it -p 3001:3001 -v ./config:/config nickrunning/wechat-selkies:latest
|
||||
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri nickrunning/wechat-selkies:latest
|
||||
```
|
||||
|
||||
2. **Access WeChat**
|
||||
|
||||
Open in browser: `https://localhost:3001` or `https://<server-ip>:3001`
|
||||
> **Note**: 3001 port is for HTTPS access. If you need HTTP access, please map port 3000 as well.
|
||||
|
||||
### docker-compose Deployment
|
||||
1. **Create project directory and navigate into it**
|
||||
@@ -71,7 +76,9 @@ docker run -it -p 3001:3001 -v ./config:/config nickrunning/wechat-selkies:lates
|
||||
image: nickrunning/wechat-selkies:latest # or ghcr.io/nickrunning/wechat-selkies:latest
|
||||
container_name: wechat-selkies
|
||||
ports:
|
||||
- "3001:3001"
|
||||
- "3000:3000" # http port
|
||||
- "3001:3001" # https port
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- ./config:/config
|
||||
devices:
|
||||
|
||||
@@ -10,7 +10,8 @@ services:
|
||||
devices:
|
||||
- /dev/dri:/dev/dri # optional, for hardware acceleration
|
||||
ports:
|
||||
- "3001:3001"
|
||||
- "3000:3000" # http port
|
||||
- "3001:3001" # https port
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- PUID=1000
|
||||
|
||||
BIN
docs/images/wechat-selkies-1.jpg
Normal file
BIN
docs/images/wechat-selkies-1.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/images/wechat-selkies-2.jpg
Normal file
BIN
docs/images/wechat-selkies-2.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Reference in New Issue
Block a user