binwiederhier/ntfy

!ntfy

ntfy.sh | 通过PUT/POST向手机或桌面发送推送通知

ntfy（发音：notify）是一个简单的基于HTTP的发布-订阅(pub-sub)通知服务。它允许您通过脚本从任何计算机向手机或桌面发送通知，完全无需注册或付费。它也是开源的（如您所见），如果您想自行部署的话。

官方提供免费版本 ntfy.sh，同时还有https://github.com/binwiederhier/ntfy-android%E7%9A%84Android%E5%BA%94%E7%94%A8%E3%80%82

镜像概述

本Docker镜像用于部署ntfy服务，包含ntfy服务器和用于发布/订阅主题的CLI工具。支持amd64、armv7和arm64架构，使用简单。详细说明可参考官方文档。

服务器通过80端口暴露Web UI和API，因此需要在Docker中映射该端口。如需使用持久化消息缓存，需将卷映射到/var/cache/ntfy。如需修改其他设置，应映射/etc/ntfy目录，以便编辑/etc/ntfy/server.yml配置文件。

核心功能和特性

• 基于HTTP的pub-sub模式：通过简单的HTTP请求实现发布-订阅通知机制
• 无需注册/付费：直接使用，无账号要求，无使用成本
• 多平台支持：可向手机（Android应用）和桌面发送通知
• 开源可自建：提供开源代码，支持私有部署，数据完全自主控制
• 轻量高效：Docker镜像体积小，支持amd64、armv7、arm64多种架构
• 功能完整：包含服务端和CLI工具，支持消息发布、订阅、持久化缓存
• 灵活配置：通过配置文件自定义服务参数，满足不同场景需求

使用场景和适用范围

• 服务器监控告警：服务器异常、日志告警等事件实时推送至管理员手机
• 脚本任务通知：自动化脚本执行结果（如备份完成、任务失败）即时通知
• 跨设备消息同步：不同设备间通过HTTP请求传递简单消息
• 私有通知系统：企业或个人部署私有通知服务，保障数据隐私
• 开发调试辅助：开发过程中关键节点事件实时通知，加速调试流程

使用方法和配置说明

基本要求

• Docker环境（支持amd64、armv7、arm64架构）
• 开放80端口（或自定义映射端口）

基本用法（无缓存或额外配置）

bash
docker run -p 80:80 -it binwiederhier/ntfy serve

带持久化缓存（通过命令行参数配置）

bash
docker run \
  -v /var/cache/ntfy:/var/cache/ntfy \
  -p 80:80 \
  -it \
  binwiederhier/ntfy \
    --cache-file /var/cache/ntfy/cache.db \
    serve

带自定义配置（通过/etc/ntfy/server.yml配置，详见配置文档）

bash
docker run \
  -v /etc/ntfy:/etc/ntfy \
  -p 80:80 \
  -it \
  binwiederhier/ntfy \
  serve

自定义Docker镜像（减少运行参数）

如需构建可独立部署的自定义镜像（无需单独传递配置文件），可使用以下Dockerfile：

dockerfile
FROM binwiederhier/ntfy
COPY server.yml /etc/ntfy/server.yml
ENTRYPOINT ["ntfy", "serve"]

构建后可推送至容器仓库，运行时仅需映射端口：

bash
docker run -p 80:80 -d your-registry/your-custom-ntfy