NotifyMe

NotifyMe 是一款小巧、闪电般快速且极其简单的Web服务，用于高效通知。它只需最少的设置，无需数据库即可运行。基于强大的Apprise Python模块，它能将通知发送到多种目标平台，包括***、Slack、短信和电子邮件。

NotifyMe 还可轻松与 Shepherd 集成，Shepherd 是一款Docker Swarm服务，能在基础镜像更新时自动更新您的服务。

支持的平台

• linux/amd64
• linux/arm64
• linux/arm32v7 (是的！您的树莓派也支持！)

快速开始

NotifyMe 以 Docker镜像 形式提供。使用前，您需要在机器上安装Docker引擎。此外，建议安装Docker Compose。

请先查看端点API文档。

快速启动（无需配置）

bash
docker run -p 8000:8000 pysergio/notifyme:latest

应用将监听8000端口。

请注意，在上述示例中，每次调用API端点时都必须提供目标URL。

通过Docker Compose和环境变量设置

在您选择的任意目录中创建 docker-compose.yml 文件：

yaml
version: '3'

services:
  notifyme:
    restart: unless-stopped
    image: pysergio/notifyme:latest
    environment:
      NOTIFYME_DEFAULT: tgram://12345678910:DKFJDHKDS-DKwsksdpORUjdsiYerk/-987654321/
      NOTIFYME_WEBAPP: mailto://server.com?smtp=smtp.server.com&from=***&to=***
      NOTIFYME_MONITOR: ***://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js,mailto://server.com?smtp=smtp.server.com&from=***&to=***
    ports:
      - "8000:8000"

然后运行命令：

bash
docker-compose up -d

在上述示例中，我们通过多个环境变量设置了不同的通知目标。现在调用端点时，只需提供 title、body 和 setting 参数，例如：

json
{
  "setting": "NOTIFYME_WEBAPP",
  "title": "注册通知",
  "body": "新用户账户已注册：..."
}

此外，由于我们设置了 NOTIFYME_DEFAULT，调用端点时甚至无需指定 url 或 setting 参数：

json
{
  "title": "注册通知",
  "body": "新用户账户已注册：..."
}

上述示例方法非常适合将NotifyMe与 Shepherd 集成（通过 APPRISE_SIDECAR_URL 环境变量提供NotifyMe URL）。

在Docker Swarm中使用

使用Docker Swarm时，您可能希望将应用设置存储在Docker密钥中。解密后的密钥会挂载到容器的内存文件系统中，容器内的默认挂载路径为 /run/secrets/<secret_name>。

您仍可使用Docker密钥文件中的数据设置NotifyMe。假设您有一个名为 tgram_notofocation_url 的Docker密钥，并希望将其关联到名为 NOTIFYME_TGRAM 的设置，只需提供环境变量 NOTIFYME_TGRAM_FILE，其值为Docker密钥的路径，例如 NOTIFYME_TGRAM_FILE=/run/secrets/tgram_notofocation_url。之后，即可在请求体中使用 NOTIFYME_TGRAM 设置调用端点：

json
{
  "setting": "NOTIFYME_TGRAM",
  "title": "标题",
  "body": "消息内容"
}

其他设置

若要将NotifyMe与Sentry集成，可选择提供两个额外的环境变量：

• SENTRY_DSN - 应包含有效的Sentry DSN字符串。
• ENVIRONMENT - 应包含环境名称（默认值为 production）。

更多示例

更多 docker-compose 文件示例，请访问 examples 目录。

授权与认证

本服务设计初衷是尽可能简单，无需数据库集成，因此不提供授权与认证功能。

若您需要此类功能或希望以任何方式限制服务访问，应通过防火墙、Web服务器、反向代理设置，或使用安全组、云服务商提供的资源级权限和条件等方式实现。

构建工具

• Python 3.9+
• FastAPI
• Apprise

版本控制

我们使用 SemVer 进行版本控制。可用版本请参见 此仓库的标签。

许可证

本项目采用MIT许可证 - 详见 LICENSE.md 文件。