levantinlynx/gotify-to-ntfy-proxy

Gotify to Ntfy Proxy

镜像概述和主要用途

这是一款专为Proxmox v8+通知系统设计的代理工具，用于实现Ntfy集成功能。由于Proxmox原生不支持Ntfy通知，该代理可将Proxmox的Gotify通知转发至Ntfy服务，同时支持Proxmox Backup Server（因其采用与Proxmox相同的通知系统）。

核心功能和特性

• 填补Proxmox v8+原生Ntfy集成空白，实现Gotify到Ntfy的通知转发
• 支持Proxmox及Proxmox Backup Server通知系统
• 多主题配置功能，可同时管理多个Ntfy主题及对应访问令牌
• 提供iOS长消息拆分解决方案，解决iOS设备不支持附件的问题
• 支持Docker容器化部署，便于快速集成到现有环境

使用场景和适用范围

• Proxmox v8+环境中需要Ntfy通知功能的用户
• Proxmox Backup Server用户需将系统通知转发至Ntfy的场景
• 需要管理多主题Ntfy通知的Proxmox管理员
• 使用iOS设备接收Proxmox通知且遇到长消息显示问题的用户

Proxmox设置步骤

1. 登录Proxmox管理界面，导航至 数据中心 > 通知 > 添加 > Gotify

2. 配置代理参数：

   • 代理地址示例：http://10.0.0.6:8008

   • Ntfy主题：your_topic_name

   • Ntfy令牌：tk_yoursupersecretntfytoken

3. 添加代理后，创建"通知匹配器"或编辑默认匹配器

配置文件说明

.env文件示例

NTFY_SERVER变量的协议部分（[***]

env
NODE_ENV=production

RELAY_HOST_IP=0.0.0.0
RELAY_PORT=8008

NTFY_SERVER=https://ntfy.sh

# iOS用户解决方法：因iOS不支持附件，设置任意值启用长消息拆分功能
SPLIT_LARGE_MESSAGES=

topic.js文件示例

javascript
const topics = {
  your_topic_name_one: {
    ntfyToken: 'tk_yoursupersecretntfytoken'
  },
  your_topic_name_two: {
    ntfyToken: 'tk_yoursupersecretntfytoken'
  },
}

module.exports = topics

本地运行方法

需确保已安装node v20+和yarn 1.22+

bash
git clone https://github.com/LevantinLynx/gotify-to-ntfy-proxy.git

cd gotify-to-ntfy-proxy

cp .env.default .env
# 编辑.env文件配置参数

cp topics.default.js topics.js
# 编辑topics.js文件配置主题和令牌
# 确保安全保存！该文件包含您的Ntfy令牌。

yarn install

yarn start

Docker部署指南

重要提示：若使用Docker容器名称进行容器间路由，需在容器名称前添加协议"http://"，例如：NTFY_SERVER=http://ntfy_container_name，否则将无法正常工作。

Docker run命令

bash
docker run \
  -p 8008:8008 \
  -v /path/to/your/.env:/home/node/app/.env \
  -v /path/to/your/topics.js:/home/node/app/topics.js \
  --restart unless-stopped \
  levantinlynx/gotify-to-ntfy-proxy:latest

Docker Compose配置

可选择通过环境变量传递配置（无需.env文件）或使用docker compose：

yaml
version: '3.9'
services:
  gotify-to-ntfy-proxy:
    image: 'levantinlynx/gotify-to-ntfy-proxy:latest'
    restart: unless-stopped
    volumes:
      - '/path/to/your/topics.js:/home/node/app/topics.js'
    ports:
      - '8008:8008'
    environment:
      - RELAY_HOST_IP=0.0.0.0
      - RELAY_PORT=8008
      - NTFY_SERVER=https://ntfy.sh
      # iOS用户解决方法：因iOS不支持附件，设置任意值启用长消息拆分，不设置则禁用
      - SPLIT_LARGE_MESSAGES= 

默认环境变量

若未提供.env文件或环境变量，服务将使用以下默认值启动：

env
NODE_ENV=production
RELAY_HOST_IP=0.0.0.0
RELAY_PORT=8008
NTFY_SERVER=https://ntfy.sh

致谢

感谢https://github.com/gotify/server%E5%92%8Chttps://github.com/binwiederhier/ntfy%E9%A1%B9%E7%9B%AE%E7%9A%84%E6%89%80%E6%9C%89%E8%B4%A1%E7%8C%AE%E8%80%85%EF%BC%8C%E6%84%9F%E8%B0%A2%E4%BB%96%E4%BB%AC%E5%88%9B%E5%BB%BA%E5%B9%B6%E7%BB%B4%E6%8A%A4%E8%BF%99%E4%BA%9B%E5%87%BA%E8%89%B2%E7%9A%84%E5%BC%80%E6%BA%90%E8%BD%AF%E4%BB%B6%E3%80%82

Logo许可说明

gotify-to-ntfy-proxy logo采用知识共享署名4.0国际公共许可协议授权。

Gotify

Gotify logo采用知识共享署名4.0国际公共许可协议授权。原始Go gopher形象由Renee French设计（[***]