From 49244cb398c900afc2d8d0c76017fa4aa00c4fe5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=9D=8E=E5=AF=BB=E6=AC=A2?= <lxh@cxh.cn>
Date: Mon, 11 Mar 2024 09:01:54 +0800
Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 58 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 37 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index d87a88a..d22c642 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,47 @@
-# wxhelper-docker
+## 自动注入`wxhelper`的微信PC版镜像
 
-## 免责声明
-本仓库发布的内容，仅用于学习研究，请勿用于非法用途和商业用途！如因此产生任何法律纠纷，均与作者无关！  
-使用此项目可能会造成封号等后果。请自行承担风险。仅用于学习研究，请勿于非法用途。
+## 注意事项
 
-## 项目介绍
-本项目是[wxhelper](https://github.com/ttttupup/wxhelper)的docker一键部署版本，自动完成微信的安装并注入。
+1. 只支持`x86`架构
+2. 宿主机系统发行版限制`Debian`系
+3. `VNC`页面切记不要手贱关闭微信窗口，否则只能重启容器
+4. `VNC`页面字体乱码是正常的，不影响接口使用
 
-关于wxhelper的具体使用方法可以参考[wxhelper](https://github.com/ttttupup/wxhelper)的README或对应分支的文档。
+## 端口
 
+1. `5900`端口，`VNC`服务的端口，需要用`VNC Viewer`之类的工具连接打开。
+2. `8080`端口(`tag`带`novnc`的镜像专属)，`noVNC`网页端口，可在浏览器打开。
+3. `19088`端口，`wxhelper`接口
 
-## 项目使用
+## 使用方式
 
-运行镜像
+```yaml
+version: '3'
 
+services:
+  wechat:
+    image: lxh01/wxhelper-docker:{tag} # 自行选择喜欢的tag
+    container_name: wechat
+    restart: unless-stopped
+    # 关闭seccomp，在非debian系宿主机运行时需要取消掉下面这两行注释
+    #security_opt:
+    #  - seccomp:unconfined
+    environment:
+      - WINEDEBUG=fixme-all
+    volumes:
+      - ./data/wechat:/home/app/.wine/drive_c/users/app/Documents/WeChat\ Files # 映射微信缓存目录
+    ports:
+      - "5900:5900" # VNC接口，使用VNC Viewer连接之后可以扫码登录微信
+      - "8080:8080" # noVNC端口，仅tag含有novnc才有这个
+      - "19088:19088" # wxhelper的接口端口
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:19088/api/checkLogin"]
+      interval: 60s
+      timeout: 10s
+      retries: 5
 ```
-docker run -d --rm -p 8080:8080 -p 19088:19088 --name wxhelper-docker hxrbunny/wxhelper-docker:latest
-```
-浏览器访问 http://127.0.0.1:8080/vnc.html 扫码登录
 
+## 鸣谢
 
-## 特别注意
-- 只支持AMD64架构，不支持ARM
-- 如果你不了解docker的网络架构也不想了解，使用host模式启动可能是更好的方案。但是注意只有Linux支持host模式
-
-## 特别感谢
-感谢下列项目,记得给大佬们点🌟  
-https://github.com/ttttupup/wxhelper  
-https://github.com/furacas/DllInjector  
-https://github.com/tom-snow/wechat-windows-versions
+[wxhelper](https://github.com/ttttupup/wxhelper)
+[wxhelper-docker](https://github.com/thinker007/wxhelper-docker)