Hass/Message-Push-Nest

Fork 0

Files

T

engigu c6cf2e13bf chroe: update readme.md for deploy

2024-01-26 16:47:28 +08:00

6.9 KiB

Raw Blame History

Message Nest 🕊️

Message Nest 是一个灵活而强大的消息推送整合平台，旨在简化并自定义多种消息通知方式。

项目名叫信息巢，意思是一个拥有各种渠道信息方式的集合站点。

如果你有很多消息推送方式，每次都需要调用各种接口去发送消息到各个渠道，或者不同的项目你都需要复制同样的发消息代码，这个项目可以帮你管理各种消息方式，并提供统一的发送api接入。你可以自由组合各种消息渠道，一个api推送到各种渠道，帮你省去接入的繁琐步骤。

演示站点(演示站点的服务器比较烂，见谅) demo

特色 ✨

🔄 整合性： 提供了多种消息推送方式，包括邮件、钉钉、企业微信等，方便你集中管理和定制通知。
🎨 自定义性： 可以根据需求定制消息推送策略，满足不同场景的个性化需求。
🛠 开放性： 易于扩展和集成新的消息通知服务，以适应未来的变化。

进度 🔨

项目还在不断更新中，欢迎大家提出各种建议。

关于日志，考虑到目前多数服务以收集控制台输出为主，暂时不支持写出日志文件。

2024.01.24

支持数据统计展示

2024.01.20

添加日志查看自动刷新

2024.01.07

支持站点信息自定义

2024.01.03

支持企业微信
单应用打包,直接运行,不用部署前端页面
支持邮件发送
用户密码设置
支持用户定时任务清理，更新定时时间
查看定时清理日志
单应用的html浏览器自动缓存
gin的日志使用logrus
支持异步发送
支持邮件发送
支持钉钉
支持自定义的webhook消息发送
企业微信
....

项目来由 💡

自己常常写一些脚本需要消息推送，经常需要接入不同的消息发送，很不方便，于是就有了这个项目。

效果图 📺

使用方法 🚀

1.直接运行最新的release打包的可执行文件（推荐，不用部署前端页面）

下载最新的系统版本对应的release，解压
新建一个数据库
重命名conf/app.example.ini为conf/app.ini
修改app.ini对应的配置
将配置中EmbedHtml = disable, 进行注释，以单应用方式运行
启动项目会自动创建表和账号

# 第一次运行将app.ini中的app.InitData设置为enable，会自动进行表数据的初始化
# 后续不需要开启这个配置
# INFO登录启动回出现如下日志

[2024-01-13 13:40:09.075]  INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_auth
[2024-01-13 13:40:11.778]  INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_tasks
[2024-01-13 13:40:16.518]  INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_ways
[2024-01-13 13:40:23.300]  INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_tasks_logs
[2024-01-13 13:40:28.715]  INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_tasks_ins
[2024-01-13 13:40:39.538]  INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_settings
[2024-01-13 13:40:46.299]  INFO [migrate.go:74 Setup] [Init Data]: Init Account data...
[2024-01-13 13:40:46.751]  INFO [migrate.go:77 Setup] [Init Data]: All table data init done.

启动项目，访问8000端口，初始账号为admin，密码为123456

2.前后端分离部署（待更新）

3. 开发调试运行

重命名conf/app.example.ini为conf/app.ini，关键配置如下

[app]
JwtSecret = message-nest
LogLevel = INFO

; 第一次运行务必打开，初始化数据
InitData = enable

[server]
; RunMode务必设置成debug，会自动添加跨域
RunMode = debug
HttpPort = 8000
ReadTimeout = 60
WriteTimeout = 60
; 取消EmbedHtml的注释（启用前后端分离），然后到web目录下面，npm run dev启动前端页面
EmbedHtml = disable

[database]
; 开启SQL打印
SqlDebug = enable

Type = mysql
User = root
Password = Aa123456
Host = vm.server
Port = 3308
Name = yourDbName
TablePrefix = message_

运行main.go，服务启动后会运行在8000端口

go mod tidy
go run main.go

启动前端页面，页面启动后会提示访问url，一般是http://127.0.0.1:5173

cd web
npm i
nom run dev

访问http://127.0.0.1:5173，进行调试开发，接口会自动转发到go服务http://localhost:8000

关于EmbedHtml配置的说明

这个配置可以理解为单应用模式（或者前后端分离）的开关

取消这个配置的注释，表示前后端分离，表示go服务启动的时候只会有api服务，需要到web目录下，npm run dev启动前端项目。然后访问前端项目提示的端口服务，一般是127.0.0.1:5173。或者使用npm run build，用Nginx部署前端。
注释这个配置，表示单应用，启动go服务，会把web/dist目录下文件作为前端静态资源。如果目录下没有静态资源文件，需要到web目录下，npm run build构建生成。

两种方式各有优缺点，综合考虑下来，推荐直接使用release的打包执行文件，其中已经内置了页面静态资源，只用运行一个服务。

完整配置说明 ⚙️

[app]
JwtSecret = message-nest
; 暂时无用
RuntimeRootPath = runtime/
LogLevel = INFO

; init table data, first run set enable
; 首次运行打开这个，会自动初始化表和数据
InitData = enable

[server]
; debug or release
RunMode = release
HttpPort = 8000
ReadTimeout = 60
WriteTimeout = 60
; use embed html static file
; 是否使用embed打包的静态资源
; 如果运行release打包后的应用，请注释这个设置。
; 如果取消这个注释，只会单独运行api服务，前端服务需要到web目录手动npm run dev, 运行前端页面
; EmbedHtml = disable   

[database]
Type = mysql
User = root
Password = password
Host = 123.1.1.1
Name = db_name
Port = 3306
; 表前缀
TablePrefix = message_
; 是否打开sql打印
; SqlDebug = enable

贡献 🤝

欢迎通过提交问题和提出改进建议。

致谢 🙏

该项目汲取了go-gin-example项目的灵感，展示了 Go 和 Gin 在实际应用中的强大和多才多艺。

许可证 📝

LICENSE

6.9 KiB Raw Blame History Unescape Escape