← Directory

shoutrrr

Notification library for gophers and their furry friends.

  • Other
  • Productivity
  • Tools & Utilities
Notification library for gophers and their furry friends. Heavily inspired by Apprise.
This is a CLI tool. Please edit the **Post Arguments** accordingly. See documentation: https://containrrr.dev/shoutrrr/dev/getting-started/

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score

Not enough data yet for a health score. It needs at least 2 of 4 factors: maintenance, popularity, ease of install, resource needs.

Availability: platform listings confirmed today, links checked 6 days ago

No GitHub repository data collected yet.

Resources & Compatibility

ARM (e.g. Raspberry Pi) is not supported.

Checked 14 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Install the prebuilt binary Use the docs' release download steps to get a ready-to-run shoutrrr program instead of building it from raw code. This avoids having to install the Go programming language first, which most first-time users don't need. source
  • Keep go/bin in PATH After install, add the go/bin folder in your user profile to your PATH (the list of folders your terminal searches for commands). If it isn't, the terminal will say shoutrrr is not found even though the file is installed. source
  • Skip contributor extras The Make (a build tool), MkDocs (a documentation site builder), and Python setup steps are for contributor tools like building docs, not for a normal install. Skip them unless you specifically want to work on the project's documentation site. source

Fetched 13 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Do first-time users need to install Go to run Shoutrrr?

No, you can use the prebuilt binary from the docs' release download steps. Add the go/bin folder to your PATH or the terminal will not find the shoutrrr command.

Do I need the Make, MkDocs, and Python setup steps to use Shoutrrr normally?

No, those steps are for contributor tooling and building the documentation site. Skip them unless you want to work on the project's documentation.

Can I run Shoutrrr in Docker instead of only in CLI mode?

Yes, the getting-started docs say you can run your own Shoutrrr instance with Docker in a few minutes.

What notification issue have users reported with Watchtower and Shoutrrr in Docker?

A user reported that Watchtower notifications sent through Shoutrrr to Discord stopped being as useful as before.

Answers sourced from github.com, github.com, shoutrrr.com, www.reddit.com

Community

Collected 13 days ago - public community threads