{"id":21204808,"url":"https://github.com/leslieleung/heimdallr","last_synced_at":"2025-04-05T23:07:44.074Z","repository":{"id":37741184,"uuid":"497120657","full_name":"LeslieLeung/heimdallr","owner":"LeslieLeung","description":"一个非常轻量的通知网关，可以聚合各种推送渠道，使用 Serverless 部署，几乎零成本运行。","archived":false,"fork":false,"pushed_at":"2024-04-22T11:43:32.000Z","size":2397,"stargazers_count":342,"open_issues_count":3,"forks_count":29,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-22T12:57:46.830Z","etag":null,"topics":["bark","discord","notification","ntfy","serverchan","serverless","telegram","wecom","wecom-bot","zeabur"],"latest_commit_sha":null,"homepage":"https://heimdallr.zeabur.app/docs","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LeslieLeung.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-05-27T19:52:20.000Z","updated_at":"2024-05-08T13:00:14.590Z","dependencies_parsed_at":"2023-01-19T15:31:02.846Z","dependency_job_id":"9ea5a206-a147-438e-b97a-717ae9154b7c","html_url":"https://github.com/LeslieLeung/heimdallr","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeslieLeung%2Fheimdallr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeslieLeung%2Fheimdallr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeslieLeung%2Fheimdallr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeslieLeung%2Fheimdallr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LeslieLeung","download_url":"https://codeload.github.com/LeslieLeung/heimdallr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411234,"owners_count":20934653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bark","discord","notification","ntfy","serverchan","serverless","telegram","wecom","wecom-bot","zeabur"],"created_at":"2024-11-20T20:40:31.417Z","updated_at":"2025-04-05T23:07:44.054Z","avatar_url":"https://github.com/LeslieLeung.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003eHeimdallr\u003c/h1\u003e\n\n\u003e 🔧该项目已经重构至新版本，API、配置项 等与原v1.x版本不兼容。若需要用旧版，请查看 [legacy 分支](https://github.com/LeslieLeung/heimdallr/tree/legacy) 。\n\n交流群：[Telegram](https://t.me/heimdallr_notification)\n\n# 简介\n\nHeimdallr 是一个非常轻量的通知网关，可以聚合各种推送渠道，使用 Serverless 部署，几乎零成本运行。\n\n# 特性\n\n- 等同于免费、开源、可自建的 [新版Server酱](https://sct.ftqq.com/)，没有任何限制，痛快推送\n- 支持各种常见的推送渠道，如Bark、企业微信等\n- 支持 [Apprise](https://github.com/caronc/apprise)，从此再也不缺通知渠道（完全列表见[链接](https://github.com/caronc/apprise#supported-notifications)）\n- 完全兼容 Bark 的路由，任意支持 Bark 的地方，都可以使用 Heimdallr 同时发送到更多渠道\n- 提供兼容 [message-pusher](https://github.com/songquanpeng/message-pusher)、[PushDeer](http://pushdeer.com) 的路由。\n- 支持发送图片（仅 Apprise）\n- 支持多通知渠道和分组配置\n- 支持 Serverless 部署，几乎零成本运行\n- 解决因为群晖DSM奇怪的 webhook 设置方式而无法接入一些推送渠道的问题\n- 提供 [配置生成器](https://heimdallr-configurator.vercel.app/)\n\n## 目前支持的通知方式\n\n- [Bark](https://github.com/Finb/Bark)\n- [企业微信应用消息](https://developer.work.weixin.qq.com/document/path/90236)\n- [企业微信机器人webhook](https://developer.work.weixin.qq.com/document/path/91770)\n- [PushDeer](http://pushdeer.com)\n- [Chanify](https://github.com/chanify/chanify) [未测试]\n- [Pushover](https://pushover.net/api) [未测试]\n- Email\n- [Discord(webhook)](https://discord.com/developers/docs/resources/webhook#execute-webhook)\n- [Telegram Bot](https://core.telegram.org/bots/api#sendmessage)\n- [ntfy](https://docs.ntfy.sh/)\n- [飞书/Lark](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot)\n- [钉钉自定义机器人](https://open.dingtalk.com/document/robots/custom-robot-access)\n- [Apprise](https://github.com/caronc/apprise)\n- [PushMe](https://push.i-i.me/)\n\n\u003e 如果有需要的通知方式，请提交 [issue](https://github.com/LeslieLeung/heimdallr/issues/new?assignees=LeslieLeung\u0026labels=enhancement\u0026template=feature_request.md\u0026title=)\n\n\n# 部署方式\n\n配置项见 [示例](.env.example)。也可以使用[配置生成器](https://heimdallr-configurator.vercel.app/)。\n\n具体配置，见 [配置文档](docs/Config.md)\n\n## 第三方服务\n\n### Vercel\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fleslieleung%2Fheimdallr\u0026project-name=heimdallr\u0026repository-name=heimdallr)\n\n### Zeabur\n\n[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/E7FFAQ?referralCode=LeslieLeung)\n\n\u003e 配置方式参考 [文档](https://zeabur.com/docs/zh-CN/environment/variables)，在编辑原始环境变量处粘贴 `.env` 的内容即可。\n\n## Serverless\n- [腾讯云Serverless](docs/deploy/TencentcloudServerless.md)\n- [阿里云Serverless](docs/deploy/AliyunServerless.md)\n\n## Docker\n见 [Docker](docs/deploy/Docker.md) （支持 `arm64`、`amd64`架构）\n\n# 接口文档\n\n见 [接口文档](https://heimdallr.zeabur.app/docs) 。\n\n## 兼容接口\n\nHeimdallr 提供与 Bark 完全兼容的接口以及与 message-pusher 兼容的接口，在支持 Bark 或 message-pusher 的服务上，将服务链接换成 Heimdallr 的链接即可把信息通过 Heimdallr 发送。\n\n### Bark 兼容接口\n\n只需要把 Bark 的服务链接换成 Heimdallr 的服务链接即可。\n\n### message-pusher 兼容接口\n\nmessage-pusher 的接口形如 `https://\u003cdomain\u003e/push/\u003cusername\u003e`，替换成 `https://\u003cdomain\u003e/competable/message-pusher/push` 即可，token 填 Heimdallr 分组的 token。\n\n### PushDeer 兼容接口\n\nPushDeer 的接口形如 `https://\u003cdomain\u003e/message/push`，替换成 `https://\u003cdomain\u003e/competable/pushdeer/message/push` 即可，pushkey 填 PushDeer 的 token。\n\n## Markdown 支持\n\n在一些支持 Markdown 的服务上，格式化的文本可以以 Markdown 格式呈现。在请求时，通过 query 参数或 json 传入 `msg_type = markdown` 即可。\n\n示例：\n\n```bash\n# GET\ncurl 'http://\u003cHOST\u003e/\u003cTOKEN\u003e/*Hello*/__World__?msg_type=markdown'\n# POST\ncurl -X POST 'http://\u003cHOST\u003e/push' --data-raw '{\n    \"key\": \"\u003cTOKEN\u003e\",\n    \"title\": \"*Hello*\",\n    \"body\": \"__World__\",\n    \"msg_type\": \"markdown\"\n}'\n```\n\n\u003e 注意，支持 Markdown 的服务中，并非所有服务都采用相同的语法。在不支持 Markdown 的服务，内容将以纯文本展示。\n\u003e\n\u003e 当前支持 Markdown 的服务及其支持的语法如下：\n\u003e - [企业微信](https://developer.work.weixin.qq.com/document/path/90236#%E6%94%AF%E6%8C%81%E7%9A%84markdown%E8%AF%AD%E6%B3%95)\n\u003e - [Discord](https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline)\n\u003e - [Telegram](https://core.telegram.org/bots/api#markdownv2-style)\n\n# 示例应用\n\n- [使用 Heimdallr 接收群晖DSM推送](docs/example/DSM.md)\n- [使用 Heimdallr 接收威联通推送](docs/example/QNAP.md)\n- [使用 Heimdallr 接收 GitHub star webhook](docs/example/GitHubStar.md)\n- [使用 Heimdallr 接收 RSS 推送](docs/example/Rsspush.md)\n\n# 更新日志\n\n见 [更新日志](docs/Changelog.md)\n\n# Stargazers over time\n[![Stargazers over time](https://starchart.cc/LeslieLeung/heimdallr.svg?variant=adaptive)](https://starchart.cc/LeslieLeung/heimdallr)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleslieleung%2Fheimdallr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleslieleung%2Fheimdallr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleslieleung%2Fheimdallr/lists"}