diff --git a/README.md b/README.md index 7454fed..3a9178e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,91 @@ -# 消息推送服务 -> 正在用 Go 重写 Message Pusher,敬请期待! +
-## TODOs -+ [ ] Token Store 测试(内存泄漏检查,不必要的拷贝的检查) -+ [ ] 添加 & 更新推送配置信息时对 Token Store 进行妥善更新 -+ [x] 微信消息推送 API -+ [x] 支持飞书 -+ [ ] 支持钉钉 -+ [ ] 支持 Telegram -+ [ ] 重新编写 README -+ [ ] 推广 -+ [ ] 支持从外部系统获取 Token -+ [ ] 支持 Bark \ No newline at end of file ++ 程序下载 + · + 使用教程 + · + 意见反馈 + · + 在线演示 +
+ +## 功能 ++ [x] 多种消息推送方式: + + [x] 邮件消息 + + [x] 微信测试号 + + [x] 企业微信 + + [x] 飞书群机器人 + + [x] 钉钉群机器人 + + [ ] 桌面客户端 + + [ ] Bark ++ [x] 多种用户验证方式: + + [x] 邮箱登录注册以及通过邮箱进行密码重置 + + [x] [GitHub 开放授权](https://github.com/settings/applications/new) + + [x] 微信公众号授权(需要 [wechat-server](https://github.com/songquanpeng/wechat-server)) ++ [x] Cloudflare Turnstile 用户校验 + +## 部署 +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`。 + +## 配置 +系统本身开箱即用。 + +你可以通过设置环境变量或者命令行参数进行配置。 + +等到系统启动后,使用 `root` 用户登录系统并做进一步的配置。 + +### 环境变量 +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` + +### 命令行参数 +1. `--port