Repository navigation
Notifications
SentryUSB can send push notifications when archiving completes, errors occur, or other important events happen. You can enable any combination of the 11 supported providers.
The easiest way is through the Setup Wizard → Notifications step:
- Open http://sentryusb.local
- Go to Settings → Open Wizard → navigate to Notifications
- Enable one or more providers and fill in the required fields
- Optionally set a Notification Title (defaults to "SentryUSB")
Free for up to 7,500 messages/month. iOS/Android apps have a one-time cost after a free trial.
- Create an account at pushover.net
- Install the Pushover app on your phone
- Copy your User Key from the Pushover dashboard
- Create a new Application and copy the Application Key
| Field | What to Enter |
|---|---|
| User Key | Your Pushover user key |
| App Key | Your application's API key |
Self-hosted notification service. Android client on Google Play, F-Droid, or APK.
- Install a Gotify server (instructions)
- Create a new Application and copy the token
| Field | What to Enter |
|---|---|
| Domain | Your Gotify server URL (e.g., https://gotify.example.com) |
| App Token | Application token |
| Priority | Message priority (default: 5) |
- Open Discord → Server Settings → Integrations → Webhooks → New Webhook
- Choose a channel, click Copy Webhook URL
| Field | What to Enter |
|---|---|
| Webhook URL | The full webhook URL |
Free. Requires the Telegram app.
- Message @userinfobot to get your Chat ID
- Create a bot via @BotFather to get your Bot Token
- Include the
botprefix in the token (e.g.,bot123456789:abc...)
| Field | What to Enter |
|---|---|
| Chat ID | Your numeric Telegram user ID |
| Bot Token | Bot token including bot prefix |
Requires IFTTT Pro for Webhooks.
- Connect the Webhooks service
- Create an applet: Webhooks trigger → Notifications action
- Set a unique Event Name
- Go to Webhooks docs → click "Documentation" → copy your Key
| Field | What to Enter |
|---|---|
| Event Name | Your applet's event name |
| Key | Your Webhooks service key |
- Go to api.slack.com → Create a custom app
- Enable Incoming Webhooks → Add Webhook to Workspace
- Copy the webhook URL
| Field | What to Enter |
|---|---|
| Webhook URL | The full Slack webhook URL |
Requires a signal-cli REST API instance on your network.
| Field | What to Enter |
|---|---|
| Signal CLI URL | URL of the REST API (e.g., http://localhost:8080) |
| From Number | Sender phone number (e.g., +1234567890) |
| To Number | Recipient phone number |
Federated messaging via Matrix.org or self-hosted.
- Create a bot account on your homeserver
- Create/join a room and find the Internal Room ID in room settings
| Field | What to Enter |
|---|---|
| Server URL | Homeserver URL (e.g., https://matrix.org) |
| Username | Bot username |
| Password | Bot password |
| Room ID | Target room (e.g., !roomid:matrix.org) |
Amazon Simple Notification Service. Free tier available.
- Create an AWS account
- Create an IAM user with SNS permissions
- Create an SNS topic and subscribe an endpoint
| Field | What to Enter |
|---|---|
| Region | AWS region (e.g., us-east-1) |
| Access Key ID | IAM access key |
| Secret Key | IAM secret key |
| Topic ARN | Full ARN of the SNS topic |
Generic HTTP webhook for Home Assistant, Node-RED, or any endpoint.
| Field | What to Enter |
|---|---|
| Webhook URL | Full URL to POST notifications to |
Free, open-source pub-sub notification service. Works with ntfy.sh (hosted) or a self-hosted instance. iOS/Android apps available.
- Subscribe to a topic at ntfy.sh (e.g.,
https://ntfy.sh/your-unique-topic) - Or self-host ntfy and use your own server URL
- If your topic is access-controlled, generate an Access Token in ntfy's account settings
| Field | What to Enter |
|---|---|
| URL & Topic | Full URL including topic (e.g., https://ntfy.sh/yourtopic) |
| Access Token | Optional auth token for protected topics |
| Priority | Message priority 1–5 (default: 3) |
If you have the Sentry Connect iPhone app, you can receive native iOS push notifications — no third-party service setup required. This also enables Live Activities with real-time archive progress on your Lock Screen and Dynamic Island.
Pairing is done with a one-time 6-character code. No accounts or API keys needed.
- Open the SentryUSB web UI → Settings → Mobile Notifications → Generate Pairing Code
- In the Sentry Connect app → Settings → Pair for Notifications → enter the code
Or, if your phone is connected to the Pi over WiFi, tap Pair Automatically in the app for a one-tap setup.
See Sentry Connect for full details on the iOS app, Live Activities, and BLE connectivity.
Notifications can also be configured by editing /root/sentryusb.conf via SSH. Set the *_ENABLED variable to true and provide the required fields:
export PUSHOVER_ENABLED=true
export PUSHOVER_USER_KEY=your_key
export PUSHOVER_APP_KEY=your_app_keyThen run /root/bin/setup-sentryusb to apply.
See the sample config file for all available config variables.