diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index c27a449..70234e8 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index 6260d2d..7d6aa6c 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,10 @@ - 🪟 **窗口切换器**:左上角增加切换悬浮窗,方便切换到后台窗口,为后续添加其它功能做基础 - 🤖 **自动启动**:可配置自动启动微信和QQ客户端(可选) +## 截图展示 +![微信截图](./docs/images/wechat-selkies-1.jpg) +![QQ截图](./docs/images/wechat-selkies-2.jpg) + ## 快速开始 ### 环境要求 @@ -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: diff --git a/README_en.md b/README_en.md index 12b6b3a..971f98b 100644 --- a/README_en.md +++ b/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 +![WeChat Screenshot](./docs/images/wechat-selkies-1.jpg) +![QQ Screenshot](./docs/images/wechat-selkies-2.jpg) + ## 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://: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: diff --git a/docker-compose.yml b/docker-compose.yml index 5f61e1f..df83939 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -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 diff --git a/docs/images/wechat-selkies-1.jpg b/docs/images/wechat-selkies-1.jpg new file mode 100644 index 0000000..f58baaa Binary files /dev/null and b/docs/images/wechat-selkies-1.jpg differ diff --git a/docs/images/wechat-selkies-2.jpg b/docs/images/wechat-selkies-2.jpg new file mode 100644 index 0000000..d7fd057 Binary files /dev/null and b/docs/images/wechat-selkies-2.jpg differ