339 lines
13 KiB
Markdown
339 lines
13 KiB
Markdown
<p align="center">
|
||
<a href="https://github.com/songquanpeng/message-pusher"><img src="https://raw.githubusercontent.com/songquanpeng/message-pusher/master/web/public/logo.png" width="150" height="150" alt="message-pusher logo"></a>
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
# 消息推送服务
|
||
|
||
_✨ 搭建专属于你的消息推送服务，支持多种消息推送方式，支持 Markdown，仅单可执行文件，开箱即用✨_
|
||
|
||
</div>
|
||
|
||
<p align="center">
|
||
<a href="https://raw.githubusercontent.com/songquanpeng/message-pusher/main/LICENSE">
|
||
<img src="https://img.shields.io/github/license/songquanpeng/message-pusher?color=brightgreen" alt="license">
|
||
</a>
|
||
<a href="https://github.com/songquanpeng/message-pusher/releases/latest">
|
||
<img src="https://img.shields.io/github/v/release/songquanpeng/message-pusher?color=brightgreen&include_prereleases" alt="release">
|
||
</a>
|
||
<a href="https://github.com/songquanpeng/message-pusher/releases/latest">
|
||
<img src="https://img.shields.io/github/downloads/songquanpeng/message-pusher/total?color=brightgreen&include_prereleases" alt="release">
|
||
</a>
|
||
<a href="https://hub.docker.com/repository/docker/justsong/message-pusher">
|
||
<img src="https://img.shields.io/docker/pulls/justsong/message-pusher?color=brightgreen" alt="docker pull">
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/songquanpeng/message-pusher/releases">程序下载</a>
|
||
·
|
||
<a href="#部署">部署教程</a>
|
||
·
|
||
<a href="#用法">使用教程</a>
|
||
·
|
||
<a href="https://github.com/songquanpeng/message-pusher/issues">意见反馈</a>
|
||
·
|
||
<a href="https://message-pusher.onrender.com/">在线演示</a>
|
||
</p>
|
||
|
||
> 公告：官方部署站 https://msgpusher.com 现已上线，当前开放注册，欢迎使用。如果收到积极反馈未来可以考虑换用延迟更低的服务器。
|
||
|
||
## 描述
|
||
1. 多种消息推送方式：
|
||
+ 邮件消息，
|
||
+ 微信测试号，
|
||
+ 企业微信应用号，
|
||
+ 企业微信群机器人
|
||
+ 飞书群机器人，
|
||
+ 钉钉群机器人，
|
||
+ Bark App,
|
||
+ WebSocket 客户端（[官方客户端](https://github.com/songquanpeng/personal-assistant)，[接入文档](./docs/API.md#websocket-客户端)），
|
||
+ Telegram 机器人，
|
||
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 -e TZ=Asia/Shanghai -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 <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 客户端进行推送。
|
||
9. `telegram`：通过 Telegram 机器人进行推送（`description` 或 `content` 字段均可，支持 Markdown 的子集）。
|
||
10. `none`：仅保存到数据库，不做推送。
|
||
5. `token`：如果你在后台设置了推送 token，则此项必填。另外可以通过设置 HTTP `Authorization` 头部设置此项。
|
||
3. `POST` 请求方式：字段与上面 `GET` 请求方式保持一致。
|
||
+ 注意：请求体编码格式为 `application/json`，`v0.3.2` 版本起支持 Post Form。
|
||
|
||
**示例：**
|
||
|
||
<details>
|
||
<summary><strong>Bash 示例 </strong></summary>
|
||
<div>
|
||
|
||
```shell
|
||
#!/bin/bash
|
||
|
||
MESSAGE_PUSHER_SERVER="https://msgpusher.com"
|
||
MESSAGE_PUSHER_USERNAME="test"
|
||
MESSAGE_PUSHER_TOKEN="666"
|
||
|
||
function send_message {
|
||
# POST Form
|
||
curl -s -X POST "$MESSAGE_PUSHER_SERVER/push/$MESSAGE_PUSHER_USERNAME" \
|
||
-d "title=$1&description=$2&content=$3&token=$MESSAGE_PUSHER_TOKEN" \
|
||
>/dev/null
|
||
}
|
||
|
||
function send_message_with_json {
|
||
# POST JSON
|
||
curl -s -X POST "$MESSAGE_PUSHER_SERVER/push/$MESSAGE_PUSHER_USERNAME" \
|
||
-H 'Content-Type: application/json' \
|
||
-d '{"title":"'"$1"'","desp":"'"$2"'", "content":"'"$3"'", "token":"'"$MESSAGE_PUSHER_TOKEN"'"}' \
|
||
>/dev/null
|
||
}
|
||
|
||
send_message 'title' 'description' 'content'
|
||
```
|
||
|
||
</div>
|
||
</details>
|
||
|
||
<details>
|
||
<summary><strong>Python 示例 </strong></summary>
|
||
<div>
|
||
|
||
```python
|
||
import requests
|
||
|
||
SERVER = "https://msgpusher.com"
|
||
USERNAME = "test"
|
||
TOKEN = "666"
|
||
|
||
|
||
def send_message(title, description, content):
|
||
# GET 方式
|
||
# res = requests.get(f"{SERVER}/push/{USERNAME}?title={title}"
|
||
# f"&description={description}&content={content}&token={TOKEN}")
|
||
|
||
# POST 方式
|
||
res = requests.post(f"{SERVER}/push/{USERNAME}", json={
|
||
"title": title,
|
||
"description": description,
|
||
"content": content,
|
||
"token": TOKEN
|
||
})
|
||
res = res.json()
|
||
if res["success"]:
|
||
return None
|
||
else:
|
||
return res["message"]
|
||
|
||
|
||
error = send_message("标题", "描述", "**Markdown 内容**")
|
||
if error:
|
||
print(error)
|
||
```
|
||
|
||
</div>
|
||
</details>
|
||
|
||
<details>
|
||
<summary><strong>Go 示例 </strong></summary>
|
||
<div>
|
||
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"bytes"
|
||
"encoding/json"
|
||
"errors"
|
||
"fmt"
|
||
"net/http"
|
||
"net/url"
|
||
)
|
||
|
||
var serverAddress = "https://msgpusher.com"
|
||
var username = "test"
|
||
var token = "666"
|
||
|
||
type request struct {
|
||
Title string `json:"title"`
|
||
Description string `json:"description"`
|
||
Content string `json:"content"`
|
||
URL string `json:"url"`
|
||
Channel string `json:"channel"`
|
||
Token string `json:"token"`
|
||
}
|
||
|
||
type response struct {
|
||
Success bool `json:"success"`
|
||
Message string `json:"message"`
|
||
}
|
||
|
||
func SendMessage(title string, description string, content string) error {
|
||
req := request{
|
||
Title: title,
|
||
Description: description,
|
||
Content: content,
|
||
Token: token,
|
||
}
|
||
data, err := json.Marshal(req)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
resp, err := http.Post(fmt.Sprintf("%s/push/%s", serverAddress, username),
|
||
"application/json", bytes.NewBuffer(data))
|
||
if err != nil {
|
||
return err
|
||
}
|
||
var res response
|
||
err = json.NewDecoder(resp.Body).Decode(&res)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
if !res.Success {
|
||
return errors.New(res.Message)
|
||
}
|
||
return nil
|
||
}
|
||
|
||
func SendMessageWithForm(title string, description string, content string) error {
|
||
resp, err := http.PostForm(fmt.Sprintf("%s/push/%s", serverAddress, username),
|
||
url.Values{"title": {title}, "description": {description}, "content": {content}, "token": {token}})
|
||
if err != nil {
|
||
return err
|
||
}
|
||
var res response
|
||
err = json.NewDecoder(resp.Body).Decode(&res)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
if !res.Success {
|
||
return errors.New(res.Message)
|
||
}
|
||
return nil
|
||
}
|
||
|
||
func main() {
|
||
//err := SendMessage("标题", "描述", "**Markdown 内容**")
|
||
err := SendMessageWithForm("标题", "描述", "**Markdown 内容**")
|
||
if err != nil {
|
||
fmt.Println("推送失败：" + err.Error())
|
||
} else {
|
||
fmt.Println("推送成功！")
|
||
}
|
||
}
|
||
```
|
||
|
||
</div>
|
||
</details>
|
||
|
||
欢迎 PR 添加更多语言的示例。
|
||
|
||
|
||
## 其他
|
||
1. `v0.3` 之前的版本基于 Node.js，你可以切换到 [`nodejs`](https://github.com/songquanpeng/message-pusher/tree/nodejs) 分支查看，该版本不再有功能性更新。
|
||
2. `v0.3` 以及后续版本基于 Gin Template [`v0.2.1`](https://github.com/songquanpeng/gin-template) 版本开发。
|