程序下载 · 部署教程 · 使用教程 · 意见反馈 · 在线演示

公告：官方部署站 https://msgpusher.com 现已上线，当前开放注册，欢迎使用。如果收到积极反馈未来可以考虑换用延迟更低的服务器。

1. 多种消息推送方式：
   • 邮件消息，
   • 微信测试号，
   • 企业微信应用号，
   • 企业微信群机器人
   • 飞书群机器人，
   • 钉钉群机器人，
   • Bark App,
   • WebSocket 客户端（官方客户端，接入文档），
2. 多种用户登录注册方式：
   • 邮箱登录注册以及通过邮箱进行密码重置。
   • GitHub 开放授权。
   • 微信公众号授权（需要额外部署 WeChat Server）。
3. 支持 Markdown。
4. 支持用户管理。
5. Cloudflare Turnstile 用户校验。
6. 支持在线发布公告，设置关于界面以及页脚。

1. 整合进自己的博客系统，每当有人登录时发微信消息提醒。
2. 在进行深度学习模型训练时，在每个 epoch 结束后将关键数据发送到微信以方便及时监控。
3. 在各种脚本运行结束后发消息提醒，例如监控 GitHub Star 数量的脚本，又例如自动健康填报的脚本，用来通知运行结果。
4. 为其他系统提供消息推送功能。

1. 从 GitHub Releases 下载可执行文件或者从源码编译：

   git clone https://github.com/songquanpeng/message-pusher.git
   go mod download
   go build -ldflags "-s -w" -o message-pusher

2. 运行：

   chmod u+x message-pusher
   ./message-pusher --port 3000 --log-dir ./logs

3. 访问 https://localhost:3000/ 并登录。初始账号用户名为 root，密码为 123456。

如果服务需要长久运行，只是单纯地启动是不够的，详细部署教程。

部署：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 证书即可，具体参考详细部署教程。

数据将会保存在宿主机的 /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:https://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 <port_number>: 指定服务器监听的端口号，默认为 3000。
   • 例子：--port 3000
2. --log-dir <log_dir>: 指定日志文件夹，如果没有设置，日志将不会被保存。
   • 例子：--log-dir ./logs
3. --version: 打印系统版本号并退出。

1. 系统设置：
   1. 填写服务器地址。
   2. 配置登录注册选项，如果系统不对外开发，请取消选择允许新用户注册。
   3. 配置 SMTP 服务，可以使用 QQ 邮箱的 SMTP 服务。
   4. 其他配置可选，请按照页面上的指示完成配置。
2. 个人设置：
   1. 点击更新用户信息更改默认用户名和密码。
   2. 点击绑定邮箱地址绑定邮箱以启用邮件消息推送方式。
3. 推送设置：
   1. 设置默认推送方式，默认为通过邮件进行推送。
   2. 设置推送 token，用以推送 API 调用鉴权，如果不需要留空即可。
   3. 设置其他推送方式，按照页面上的指示即可，完成配置后点击对应的测试按钮即可测试配置是否成功。
4. 其他设置：如果系统对外提供服务，本系统也提供了一定的个性化设置功能，你可以设置关于界面和页脚，以及发布公告。

1. 消息推送 API URL：https://<domain>/push/<username>
   • 将上面的 <domain> 以及 <username> 替换为真实值，例如：https://push.mydomain.cn/push/admin
2. GET 请求方式：https://<domain>/push/<username>?title=<标题>&description=<描述>&content=<Markdown 文本>&channel=<推送方式>&token=<推送 token>
   1. title：选填，受限于具体的消息推送方式，其可能被忽略。
   2. description：必填，可以替换为 desp。
   3. content：选填，受限于具体的消息推送方式，Markdown 语法的支持有所区别。
   4. channel：选填，如果不填则系统使用你在后台设置的默认推送方式。可选的推送方式有：
      1. email：通过发送邮件的方式进行推送。
      2. test：通过微信测试号进行推送。
      3. corp_app：通过企业微信应用号进行推送。
      4. corp：通过企业微信群机器人推送。
      5. lark：通过飞书群机器人进行推送。
      6. ding：通过钉钉群机器人进行推送。
      7. bark：通过 Bark 进行推送。
      8. client：通过 WebSocket 客户端进行推送。
   5. token：如果你在后台设置了推送 token，则此项必填。另外可以通过设置 HTTP Authorization 头部设置此项。
3. POST 请求方式：字段与上面 GET 请求方式保持一致。
   • 注意：请求体编码格式为 application/json。

示例：

import requests

# GET 方式
res = requests.get("https://your.domain.com/push/username?title={}&description={}&token={}".format("标题", "描述", "666"))

# POST 方式
res = requests.post("https://your.domain.com/push/username", json={
    "title": "标题",
    "description": "描述",
    "content": "**Markdown 内容**",
    "token": "6666"
})

print(res.text)
# 输出为：{"success":true,"message":"ok"}

1. v0.3 之前的版本基于 Node.js，你可以切换到 nodejs 分支查看，该版本不再有功能性更新。
2. v0.3 以及后续版本基于 Gin Template v0.2.1 版本开发。