nickfedor/shoutrrr

Shoutrrr

概述

Shoutrrr是一个为Go开发者及其应用设计的通知库，受caronc/apprise启发，支持通过多种服务渠道发送通知。它提供灵活的集成方式，可作为CLI工具、Go包、Docker容器或GitHub Action使用，方便在各种环境中实现事件通知功能。

核心功能与特性

• 多服务支持：集成多种通知服务，包括Slack、***、邮件、***等
• 多平台集成：提供CLI工具、Go开发包、Docker镜像及GitHub Action，适应不同使用场景
• 简单易用：通过URL格式配置通知服务，支持单个或多个服务同时发送
• 跨平台兼容：支持Windows、Linux、macOS等多种操作系统及不同架构
• 可靠稳定：完善的测试和CI/CD流程，确保功能稳定性

使用场景与适用范围

• Go项目开发：作为库集成到Go应用中，实现事件通知功能
• Docker环境：监控容器事件（如更新、错误）并发送通知
• CI/CD流程：在GitHub Actions等CI/CD环境中发送构建、部署结果通知
• 系统监控：配合监控工具发送系统告警、状态变更通知
• 自动化工具：与Watchtower等自动化工具集成，实现容器更新通知

安装方法

从源码安装

bash
go install github.com/nicholas-fedor/shoutrrr/shoutrrr@latest

二进制安装

将最新版本二进制文件安装到$HOME/go/bin（确保该路径在环境变量PATH中）：

• Windows (amd64)：

  powershell
  New-Item -ItemType Directory -Path $HOME\go\bin -Force | Out-Null; iwr (iwr https://api.github.com/repos/nicholas-fedor/shoutrrr/releases/latest | ConvertFrom-Json).assets.where({$_.name -like "*windows_amd64*.zip"}).browser_download_url -OutFile shoutrrr.zip; Add-Type -AssemblyName System.IO.Compression.FileSystem; ($z=[System.IO.Compression.ZipFile]::OpenRead("$PWD\shoutrrr.zip")).Entries | ? {$_.Name -eq 'shoutrrr.exe'} | % {[System.IO.Compression.ZipFileExtensions]::ExtractToFile($_, "$HOME\go\bin\$($_.Name)", $true)}; $z.Dispose(); rm shoutrrr.zip; if (Test-Path "$HOME\go\bin\shoutrrr.exe") { Write-Host "Successfully installed shoutrrr.exe to $HOME\go\bin" } else { Write-Host "Failed to install shoutrrr.exe" }
  

• Linux (amd64)：

  bash
  mkdir -p $HOME/go/bin && curl -L $(curl -s https://api.github.com/repos/nicholas-fedor/shoutrrr/releases/latest | grep -o 'https://[^"]*linux_amd64[^"]*\.tar\.gz') | tar -xz --strip-components=1 -C $HOME/go/bin shoutrrr
  

• macOS (amd64)：

  bash
  mkdir -p $HOME/go/bin && curl -L $(curl -s https://api.github.com/repos/nicholas-fedor/shoutrrr/releases/latest | grep -o 'https://[^"]*darwin_amd64[^"]*\.tar\.gz') | tar -xz --strip-components=1 -C $HOME/go/bin shoutrrr
  

注意：其他架构（如arm、arm64、i386、riscv64）可访问https://github.com/nicholas-fedor/shoutrrr/releases%E8%8E%B7%E5%8F%96%E3%80%82

容器镜像

• Docker Hub：

  bash
  docker pull docker.xuanyuan.run/nickfedor/shoutrrr:latest
  

• GHCR：

  bash
  docker pull ***-ghcr.xuanyuan.run/nicholas-fedor/shoutrrr:latest
  

注意：标签说明：latest（稳定版）、vX.Y.Z（特定版本）、latest-dev（开发版）、平台特定标签（如amd64-latest）。

Go包

bash
go get github.com/nicholas-fedor/shoutrrr@latest

GitHub Action

yaml
- name: Shoutrrr
  uses: nicholas-fedor/shoutrrr-action@v1
  with:
    url: ${{ secrets.SHOUTRRR_URL }}
    title: Deployed ${{ github.sha }}
    message: See changes at ${{ github.event.compare }}.

使用方法

CLI使用

bash
shoutrrr send --url "slack://hook:T00000000-B00000000-XXXXXXXXXXXXXXXXXXXXXXXX@webhook" --message "Hello, Slack!"

Go包使用

go
import "github.com/nicholas-fedor/shoutrrr"

errs := shoutrrr.Send("slack://hook:T00000000-B00000000-XXXXXXXXXXXXXXXXXXXXXXXX@webhook", "Hello, Slack!")
if len(errs) > 0 {
    // 处理错误
}

Docker使用

bash
docker run --rm docker.xuanyuan.run/nickfedor/shoutrrr:latest send --url "slack://hook:T00000000-B00000000-XXXXXXXXXXXXXXXXXXXXXXXX@webhook" --message "Hello, Slack!"

GitHub Action使用

详见安装方法中的示例。

作为Go包使用

方法1：使用直接发送命令

go
url := "slack://token-a/token-b/token-c"
err := shoutrrr.Send(url, "Hello world (或Slack频道) !")

方法2：使用发送器

单个URL

go
url := "slack://token-a/token-b/token-c"
sender, err := shoutrrr.CreateSender(url)
sender.Send("Hello world (或Slack频道) !", map[string]string{ /* 额外参数 */ })

多个URL

go
urls := []string{
  "slack://token-a/token-b/token-c",
  "discord://token@channel"
}
sender, err := shoutrrr.CreateSender(urls...)
sender.Send("Hello world (或Slack频道) !", map[string]string{ /* 额外参数 */ })

通过CLI使用

bash
shoutrrr send [选项] <URL> <消息内容 [...]>

支持的服务