diff --git a/README.md b/README.md index 3a9178e..a5a53ec 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # 消息推送服务 -_✨ 搭建专属于你的消息推送服务,支持通过邮件,微信测试号,企业微信,飞书,钉钉等推送消息,支持 Markdown✨_ +_✨ 搭建专属于你的消息推送服务,支持多种消息推送方式,支持 Markdown,仅单可执行文件,开箱即用✨_ @@ -35,6 +35,8 @@ _✨ 搭建专属于你的消息推送服务,支持通过邮件,微信测试 在线演示
+> 注意:Message Pusher 原本基于 Node.js 开发,当前版本为 Golang 重构版本,目前处于预发布阶段,可能不太稳定,如果需要稳定版请使用[旧版本](https://github.com/songquanpeng/message-pusher/releases/tag/v0.2.3)。 + ## 功能 + [x] 多种消息推送方式: + [x] 邮件消息 @@ -44,7 +46,7 @@ _✨ 搭建专属于你的消息推送服务,支持通过邮件,微信测试 + [x] 钉钉群机器人 + [ ] 桌面客户端 + [ ] Bark -+ [x] 多种用户验证方式: ++ [x] 多种用户登录注册方式: + [x] 邮箱登录注册以及通过邮箱进行密码重置 + [x] [GitHub 开放授权](https://github.com/settings/applications/new) + [x] 微信公众号授权(需要 [wechat-server](https://github.com/songquanpeng/wechat-server)) @@ -65,7 +67,7 @@ _✨ 搭建专属于你的消息推送服务,支持通过邮件,微信测试 3. 访问 [http://localhost:3000/](http://localhost:3000/) 并登录。初始账号用户名为 `root`,密码为 `123456`。 ## 配置 -系统本身开箱即用。 +系统本身仅需要下载一个可执行文件即可开始使用,无其他依赖。 你可以通过设置环境变量或者命令行参数进行配置。 @@ -87,5 +89,56 @@ _✨ 搭建专属于你的消息推送服务,支持通过邮件,微信测试 3. `--version`: 打印系统版本号并退出。 +### 进一步的配置 +1. 系统设置: + 1. 填写服务器地址。 + 2. 配置登录注册选项,如果系统不对外开发,请取消选择`允许新用户注册`。 + 3. 配置 SMTP 服务,可以使用 QQ 邮箱的 SMTP 服务。 + 4. 其他配置可选,请按照页面上的指示完成配置。 +2. 个人设置: + 1. 点击`更新用户信息`更改默认用户名和密码。 + 2. 点击`绑定邮箱地址`绑定邮箱以启用邮件消息推送方式。 +3. 推送设置: + 1. 设置`默认推送方式`,默认为通过邮件进行推送。 + 2. 设置`推送 token`,用以推送 API 调用鉴权,如果不需要留空即可。 + 3. 设置其他推送方式,按照页面上的指示即可,完成配置后点击对应的`测试`按钮即可测试配置是否成功。 +4. 其他设置:如果系统对外提供服务,本系统也提供了一定的个性化设置功能,你可以设置关于界面和页脚,以及发布公告。 + ## 用法 -TODO \ No newline at end of file +1. 消息推送 API URL:`https://