Skip to content

LeslieLeung/heimdallr

Repository files navigation

Heimdallr

🔧该项目已经重构至新版本,API、配置项 等与原v1.x版本不兼容。若需要用旧版,请查看 legacy 分支

交流群:Telegram

简介

Heimdallr 是一个非常轻量的通知网关,可以聚合各种推送渠道,使用 Serverless 部署,几乎零成本运行。

特性

  • 等同于免费、开源、可自建的 新版Server酱,没有任何限制,痛快推送
  • 支持各种常见的推送渠道,如Bark、企业微信等
  • 支持 Apprise,从此再也不缺通知渠道(完全列表见链接
  • 完全兼容 Bark 的路由,任意支持 Bark 的地方,都可以使用 Heimdallr 同时发送到更多渠道
  • 支持发送图片(仅 Apprise)
  • 支持多通知渠道和分组配置
  • 支持 Serverless 部署,几乎零成本运行
  • 解决因为群晖DSM奇怪的 webhook 设置方式而无法接入一些推送渠道的问题
  • 提供配置生成器

目前支持的通知方式

如果有需要的通知方式,请提交 issue

部署方式

配置项见 示例

具体配置,见 配置文档

可以使用 配置生成器 生成需要的配置。

第三方服务

Zeabur

Deploy on Zeabur

配置方式参考 文档,在编辑原始环境变量处粘贴 .env 的内容即可。

Serverless

Docker

Docker (支持 arm64amd64架构)

接口文档

接口文档

Markdown 支持

在一些支持 Markdown 的服务上,格式化的文本可以以 Markdown 格式呈现。在请求时,通过 query 参数或 json 传入 msg_type = markdown 即可。

示例:

# GET
curl 'http://<HOST>/<TOKEN>/*Hello*/__World__?msg_type=markdown'
# POST
curl -X POST 'http://<HOST>/push' --data-raw '{
    "key": "<TOKEN>",
    "title": "*Hello*",
    "body": "__World__",
    "msg_type": "markdown"
}'

注意,支持 Markdown 的服务中,并非所有服务都采用相同的语法。在不支持 Markdown 的服务,内容将以纯文本展示。

当前支持 Markdown 的服务及其支持的语法如下:

示例应用

更新日志

更新日志

Stargazers over time

Stargazers over time