go-wxhelper/readme.md
2024-02-26 15:26:37 +08:00

108 lines
2.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 食用方式
0. 新建一个文件夹
```shell
mkdir wechat-hook # 名字随便写
cd wechat-hook
```
1. 创建配置文件`config.yaml`
```shell
mkdir config # 先创建一个文件夹保存配置文件,文件名不要变
vim config.yaml # 编辑配置文件内容如下最新配置请参考项目里的config.yaml文件
```
```yaml
# 微信HOOK配置
wechat:
# 微信HOOK接口地址
host: wechat:19088
# 微信容器映射出来的vnc页面地址没有就不填
vncUrl: http://192.168.1.175:19087/vnc_lite.html
# 是否在启动的时候自动设置hook服务的回调
autoSetCallback: true
# 回调IP如果是Docker运行本参数必填如果Docker修改了映射格式为 ip:port如果使用项目提供的docker-compsoe.yaml文件启动可以填`auto`
callback: auto
# 数据库
mysql:
host: mysql
port: 3306
user: wechat
password: wechat
db: wechat
task:
enable: false
syncFriends:
enable: true
cron: '0 * * * *'
waterGroup:
enable: true
cron:
yesterday: '30 9 * * *' # 每天9:30
week: '30 9 * * 1' # 每周一9:30
month: '30 9 1 * *' # 每月1号9:30
```
2. 创建`docker-compose.yaml`文件
```yaml
version: '3.9'
services:
wechat:
image: lxh01/wxhelper-docker:3.9.5.81-v11-novnc
container_name: gw-wechat
restart: unless-stopped
environment:
- WINEDEBUG=fixme-all
volumes:
- ./data/wechat:/home/app/.wine/drive_c/users/app/Documents/WeChat\ Files
ports:
- "19086:5900" # vnc端口
- "19087:8080" # noVNC端口
- "19088:19088" # 微信HOOK端口
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:19088/api/checkLogin"]
interval: 60s
timeout: 10s
retries: 5
mysql:
image: mysql:8
container_name: gw-db
restart: unless-stopped
depends_on:
wechat:
condition: service_healthy
environment:
- MYSQL_ROOT_PASSWORD=wechat
- MYSQL_USER=wechat
- MYSQL_PASSWORD=wechat
- MYSQL_DATABASE=wechat
volumes:
- ./data/db:/var/lib/mysql
wxhelper:
image: gitee.ltd/lxh/go-wxhelper:latest
container_name: gw-service
restart: unless-stopped
depends_on:
- mysql
volumes:
# 配置文件请参阅项目根目录的config.yaml文件
- ./config/config.yaml:/app/config.yaml
ports:
- "19099:19099"
```
3. 启动
```shell
# 以下命令选个能用的就行
docker-compose up -d # 老版本
docker compose up -d # 新版本
```
## 注意事项
1. 宿主机必须是`debian`系,因为`wine`的玄学`BUG`,其他系统可能会出现各种问题
2. 登录微信可以用`vnc viewer`连接`5900`端口或者访问`noVNC`端口的`vnc_lite.html`页面进行扫码登录