Debian Codegraph @

docs/installation/index.md

raw
1 ---
2 hide:
3 - navigation
4 ---
5 # Installation
6
7 ## Overview
8
9 Shoutrrr is available via source code, released binaries, container images, and a GitHub Action.
10
11 ## Build and Install from Source
12
13 ```bash title="Install from Source"
14 go install github.com/nicholas-fedor/shoutrrr/shoutrrr@latest
15 ```
16
17 ## GitHub Release Binary Installation
18
19 The following scripts install the latest release binary to the user's `$HOME/go/bin` directory. Ensure this directory is in your `PATH` to enable execution without specifying the full binary path.
20 <!-- markdownlint-disable -->
21 === "Windows (amd64)"
22
23 ```powershell title="Windows (amd64) Installation"
24 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" }
25 ```
26
27 === "Linux (amd64)"
28
29 ```bash title="Linux (amd64) Installation"
30 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
31 ```
32
33 === "macOS (amd64)"
34
35 ```bash title="macOS (amd64) Installation"
36 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
37 ```
38 <!-- markdownlint-restore -->
39 !!! Note
40 Review the [release page](https://github.com/nicholas-fedor/shoutrrr/releases) for additional architectures (e.g., arm, arm64, i386, riscv64).
41
42 ## Container Images
43
44 Shoutrrr provides lightweight Docker images based on Alpine Linux, supporting multiple architectures (amd64, arm64, arm/v6, i386, riscv64). Images are available on Docker Hub and GitHub Container Registry (GHCR).
45 <!-- markdownlint-disable -->
46 === "Docker Hub"
47
48 ```bash title="Pull from Docker Hub"
49 docker pull nickfedor/shoutrrr:latest
50 ```
51
52 - **Repository**: <https://hub.docker.com/r/nickfedor/shoutrrr>
53 - **Image Reference**: `nickfedor/shoutrrr`
54 - **Tags**: `latest`, `vX.Y.Z` (e.g., `v0.8.0`), `nightly`, platform-specific (e.g., `amd64-nightly`)
55
56 === "GitHub Container Registry"
57
58 ```bash title="Pull from GHCR"
59 docker pull ghcr.io/nicholas-fedor/shoutrrr:latest
60 ```
61
62 - **Repository**: <https://github.com/nicholas-fedor/shoutrrr/pkgs/container/shoutrrr>
63 - **Image Reference**: `ghcr.io/nicholas-fedor/shoutrrr`
64 - **Tags**: `latest`, `vX.Y.Z` (e.g., `v0.8.0`), `nightly`, platform-specific (e.g., `arm64v8-nightly`)
65 <!-- markdownlint-restore -->
66 !!! Note
67 Use `latest` for the latest stable release, versioned tags (e.g., `v0.8.0`) for specific releases, or `nightly` for a rolling release image. Platform-specific tags are available for targeted deployments.
68
69 ## Go Package
70
71 Add Shoutrrr to your Go project using:
72
73 ```bash title="Add Go Package"
74 go get github.com/nicholas-fedor/shoutrrr@latest
75 ```
76
77 ## GitHub Action
78
79 Use Shoutrrr in GitHub workflows to send notifications.
80
81 ```yaml title="Example GitHub Workflow with Shoutrrr"
82 name: Deploy
83 on:
84 push:
85 branches:
86 - main
87
88 jobs:
89 build:
90 runs-on: ubuntu-latest
91 steps:
92 - name: Some other steps needed for deploying
93 run: ...
94 - name: Shoutrrr
95 uses: nicholas-fedor/shoutrrr-action@v1
96 with:
97 url: ${{ secrets.SHOUTRRR_URL }}
98 title: Deployed ${{ github.sha }}
99 message: See changes at ${{ github.event.compare }}.
100 ```
101
102 !!! Note
103 Pin the action to a specific SHA or version tag (e.g., `@v1`) and manage updates with Dependabot or Renovate for stability.