Home

Awesome

<div align="center"> <a href="https://github.com/containrrr/shoutrrr"> <img src="https://raw.githubusercontent.com/containrrr/shoutrrr/main/docs/shoutrrr-logotype.png" width="450" /> </a>

Shoutrrr

Notification library for gophers and their furry friends. Heavily inspired by <a href="https://github.com/caronc/apprise">caronc/apprise</a>.

github actions workflow status codecov Codacy Badge report card go.dev reference github code size in bytes license godoc <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> All Contributors

<!-- ALL-CONTRIBUTORS-BADGE:END --> </div> <br/><br/>

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 the build.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 the action on GitHub Marketplace:

name: Deploy
on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Some other steps needed for deploying
        run: ...
      - name: Shoutrrr
        uses: containrrr/shoutrrr-action@v1
        with:
          url: ${{ secrets.SHOUTRRR_URL }}
          title: Deployed ${{ github.sha }}
          message: See changes at ${{ github.event.compare }}.

Documentation

For additional details, visit the full documentation.

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://github.com/amirschnell"><img src="https://avatars3.githubusercontent.com/u/9380508?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Amir Schnell</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=amirschnell" title="Code">๐Ÿ’ป</a></td> <td align="center"><a href="https://piksel.se"><img src="https://avatars2.githubusercontent.com/u/807383?v=4?s=100" width="100px;" alt=""/><br /><sub><b>nils mรฅsรฉn</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=piksel" title="Code">๐Ÿ’ป</a> <a href="https://github.com/containrrr/shoutrrr/commits?author=piksel" title="Documentation">๐Ÿ“–</a> <a href="#maintenance-piksel" title="Maintenance">๐Ÿšง</a></td> <td align="center"><a href="https://github.com/lukapeschke"><img src="https://avatars1.githubusercontent.com/u/17085536?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Luka Peschke</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=lukapeschke" title="Code">๐Ÿ’ป</a> <a href="https://github.com/containrrr/shoutrrr/commits?author=lukapeschke" title="Documentation">๐Ÿ“–</a></td> <td align="center"><a href="https://github.com/MrLuje"><img src="https://avatars0.githubusercontent.com/u/632075?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MrLuje</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=MrLuje" title="Code">๐Ÿ’ป</a> <a href="https://github.com/containrrr/shoutrrr/commits?author=MrLuje" title="Documentation">๐Ÿ“–</a></td> <td align="center"><a href="http://simme.dev"><img src="https://avatars0.githubusercontent.com/u/1596025?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Simon Aronsson</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=simskij" title="Code">๐Ÿ’ป</a> <a href="https://github.com/containrrr/shoutrrr/commits?author=simskij" title="Documentation">๐Ÿ“–</a> <a href="#maintenance-simskij" title="Maintenance">๐Ÿšง</a></td> <td align="center"><a href="https://arnested.dk"><img src="https://avatars2.githubusercontent.com/u/190005?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Arne Jรธrgensen</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=arnested" title="Documentation">๐Ÿ“–</a> <a href="https://github.com/containrrr/shoutrrr/commits?author=arnested" title="Code">๐Ÿ’ป</a></td> <td align="center"><a href="https://github.com/atighineanu"><img src="https://avatars1.githubusercontent.com/u/27206712?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexei Tighineanu</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=atighineanu" title="Code">๐Ÿ’ป</a></td> </tr> <tr> <td align="center"><a href="https://github.com/ellisab"><img src="https://avatars2.githubusercontent.com/u/1402047?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexandru Bonini</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=ellisab" title="Code">๐Ÿ’ป</a></td> <td align="center"><a href="https://senan.xyz"><img src="https://avatars0.githubusercontent.com/u/6832539?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Senan Kelly</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=sentriz" title="Code">๐Ÿ’ป</a></td> <td align="center"><a href="https://github.com/JonasPf"><img src="https://avatars.githubusercontent.com/u/2216775?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JonasPf</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=JonasPf" title="Code">๐Ÿ’ป</a></td> <td align="center"><a href="https://github.com/claycooper"><img src="https://avatars.githubusercontent.com/u/3612906?v=4?s=100" width="100px;" alt=""/><br /><sub><b>claycooper</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=claycooper" title="Documentation">๐Ÿ“–</a></td> <td align="center"><a href="http://ko-fi.com/disyer"><img src="https://avatars.githubusercontent.com/u/16326697?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Derzsi Dรกniel</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=darktohka" title="Code">๐Ÿ’ป</a></td> <td align="center"><a href="https://josephkav.io"><img src="https://avatars.githubusercontent.com/u/4267227?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joseph Kavanagh</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/commits?author=JosephKav" title="Code">๐Ÿ’ป</a> <a href="https://github.com/containrrr/shoutrrr/issues?q=author%3AJosephKav" title="Bug reports">๐Ÿ›</a></td> <td align="center"><a href="https://ring0.lol"><img src="https://avatars.githubusercontent.com/u/1893909?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Justin Steven</b></sub></a><br /><a href="https://github.com/containrrr/shoutrrr/issues?q=author%3Ajustinsteven" title="Bug reports">๐Ÿ›</a></td> </tr> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

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

Related Project(s)