containrrr/shoutrrrPublic

NotificationsYou must be signed in to change notification settings
Fork70
Star1.2k

Notification library for gophers and their furry friends.

License

MIT license

1.2k stars 70 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 389 Commits
.github		.github
docs		docs
internal		internal
pkg		pkg
shoutrrr		shoutrrr
snap		snap
.all-contributorsrc		.all-contributorsrc
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
build.sh		build.sh
generate-release-notes.sh		generate-release-notes.sh
generate-service-config-docs.sh		generate-service-config-docs.sh
go.mod		go.mod
go.sum		go.sum
goreleaser.yml		goreleaser.yml
mkdocs.yml		mkdocs.yml
shoutrrr.go		shoutrrr.go

Repository files navigation

Shoutrrr

Notification library for gophers and their furry friends.Heavily inspired bycaronc/apprise.

Installation

Using the snap

$ sudo snap install shoutrrr

Using the Go CLI

$ go install github.com/containrrr/shoutrrr/shoutrrr@latest

From Source

$ go build -o shoutrrr ./shoutrrr

Quick Start

As a package

Using shoutrrr is easy! There is currently two ways of using it as a package.

Using the direct send command

url:="slack://token-a/token-b/token-c"err:=shoutrrr.Send(url,"Hello world (or slack channel) !")

Using a sender

url:="slack://token-a/token-b/token-c"sender,err:=shoutrrr.CreateSender(url)sender.Send("Hello world (or slack channel) !",map[string]string {/* ... */ })

Using a sender with multiple URLs

urls:= []string {"slack://token-a/token-b/token-c""discord://token@channel"  }sender,err:=shoutrrr.CreateSender(urls...)sender.Send("Hello world (or slack channel) !",map[string]string {/* ... */ })

Through the CLI

Start by running thebuild.sh script.You may then run send notifications using the shoutrrr executable:

$ shoutrrr send [OPTIONS]<URL><Message [...]>

From a GitHub Actions workflow

You can also use Shoutrrr from a GitHub Actions workflow.

See this example and theaction on GitHubMarketplace:

name:Deployon:push:branches:      -mainjobs:build:runs-on:ubuntu-lateststeps:      -name:Some other steps needed for deployingrun:...      -name:Shoutrrruses:containrrr/shoutrrr-action@v1with:url:${{ secrets.SHOUTRRR_URL }}title:Deployed ${{ github.sha }}message:See changes at ${{ github.event.compare }}.

Documentation

For additional details, visit thefull documentation.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Amir Schnell} 💻	_{nils måsén} 💻📖🚧	_{Luka Peschke} 💻📖	_MrLuje 💻📖	_{Simon Aronsson} 💻📖🚧	_{Arne Jørgensen} 📖💻	_{Alexei Tighineanu} 💻
_{Alexandru Bonini} 💻	_{Senan Kelly} 💻	_JonasPf 💻	_claycooper 📖	_{Derzsi Dániel} 💻	_{Joseph Kavanagh} 💻🐛	_{Justin Steven} 🐛

This project follows theall-contributors specification. Contributions of any kind welcome!

Related Project(s)

watchtower - process for automating Docker container base image updates that uses shoutrrr for notifications
kured - kubernetes reboot daemon has adopted shoutrrr as their unified notification method starting with version 1.7.0.
Green Orb - a versatile 'observe and report' buddy for your application logs