程序下载 · 部署教程 · 使用教程 · 意见反馈 · 在线演示
> 公告:官方部署站 https://msgpusher.com 现已上线,当前开放注册,欢迎使用。如果收到积极反馈未来可以考虑换用延迟更低的服务器。 ## 描述 1. 多种消息推送方式: + 邮件消息, + 微信测试号, + 企业微信应用号, + 企业微信群机器人 + 飞书群机器人, + 钉钉群机器人, + Bark App, + WebSocket 客户端([官方客户端](https://github.com/songquanpeng/personal-assistant),[接入文档](./docs/API.md#websocket-客户端)), 2. 多种用户登录注册方式: + 邮箱登录注册以及通过邮箱进行密码重置。 + [GitHub 开放授权](https://github.com/settings/applications/new)。 + 微信公众号授权(需要额外部署 [WeChat Server](https://github.com/songquanpeng/wechat-server))。 3. 支持 Markdown。 4. 支持用户管理。 5. Cloudflare Turnstile 用户校验。 6. 支持在线发布公告,设置关于界面以及页脚。 ## 用途 1. [整合进自己的博客系统,每当有人登录时发微信消息提醒](https://github.com/songquanpeng/blog/blob/486d63e96ef7906a6c767653a20ec2d3278e9a4a/routes/user.js#L27)。 2. 在进行深度学习模型训练时,在每个 epoch 结束后[将关键数据发送到微信](https://github.com/songquanpeng/pytorch-template/blob/b2ba113659056080d3009b3014a67e977e2851bf/solver/solver.py#L223)以方便及时监控。 3. 在各种脚本运行结束后发消息提醒,例如[监控 GitHub Star 数量的脚本](https://github.com/songquanpeng/scripts/blob/main/star_watcher.py),又例如[自动健康填报的脚本](https://github.com/songquanpeng/daily-report),用来通知运行结果。 4. 为[其他系统](https://github.com/songquanpeng/personal-assistant#个人助理应用)提供消息推送功能。 ## 部署 ### 手动部署 1. 从 [GitHub Releases](https://github.com/songquanpeng/message-pusher/releases/latest) 下载可执行文件或者从源码编译: ```shell git clone https://github.com/songquanpeng/message-pusher.git go mod download go build -ldflags "-s -w" -o message-pusher ```` 2. 运行: ```shell chmod u+x message-pusher ./message-pusher --port 3000 --log-dir ./logs ``` 3. 访问 [http://localhost:3000/](http://localhost:3000/) 并登录。初始账号用户名为 `root`,密码为 `123456`。 如果服务需要长久运行,只是单纯地启动是不够的,[详细部署教程](https://iamazing.cn/page/how-to-deploy-a-website)。 ### 通过 Docker 部署 部署:`docker run -d --restart always --name message-pusher -p 3000:3000 -v /home/ubuntu/data/message-pusher:/data justsong/message-pusher` 更新:`docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower -cR` 开放的端口号为 3000,之后用 Nginx 配置域名,反代以及 SSL 证书即可,具体参考[详细部署教程](https://iamazing.cn/page/how-to-deploy-a-website)。 数据将会保存在宿主机的 `/home/ubuntu/data/message-pusher` 目录(只有一个 SQLite 数据库文件)。 ### 注意 如果需要使用 WebSocket 客户端推送功能,则 Nginx 的配置文件中 `proxy_read_timeout` 和 `proxy_send_timeout` 务必设置超过 1 分钟。 推荐设置: ``` proxy_read_timeout 300s; proxy_send_timeout 300s; ``` ## 配置 系统本身仅需要下载一个可执行文件即可开始使用,无其他依赖。 你可以通过设置环境变量或者命令行参数进行配置。 等到系统启动后,使用 `root` 用户登录系统并做进一步的配置,默认密码为 `123456`。 ### 环境变量 1. `REDIS_CONN_STRING`:设置之后将使用 Redis 作为请求频率限制的存储,而非使用内存存储。 + 例子:`REDIS_CONN_STRING=redis://default:redispw@localhost:49153` 2. `SESSION_SECRET`:设置之后将使用固定的会话密钥,这样系统重新启动后已登录用户的 cookie 将依旧有效。 + 例子:`SESSION_SECRET=random_string` 3. `SQL_DSN`:设置之后将使用指定数据库而非 SQLite。 + 例子:`SQL_DSN=root:123456@tcp(localhost:3306)/message-pusher` 注意:使用 Docker 部署时,请使用 `-e key=value` 设置环境变量。 例子:`docker run -e SESSION_SECRET=random_string ...` ### 命令行参数 1. `--port