Skip to content

Add docs for ntfy alerts (#4779) #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .gitbook/assets/ntfy-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/ntfy_alert.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/ntfy_subscribe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions alerts/ntfy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ntfy

![](../.gitbook/assets/ntfy-logo.png)

[ntfy] (pronounced notify) is a simple HTTP-based pub-sub notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, and/or using a REST API.

## Configuring ntfy Alerts

1. **Subscribe to a topic**: for example, on desktop:

![ntfy Topic Subscription](../.gitbook/assets/ntfy_subscribe.png)

2. **Turn on ntfy alerts** in the [LinuxGSM settings](../configuration/linuxgsm-config.md). \(`~/lgsm/config-lgsm/<gameserver>/common.cfg`\)

_Note: The only required setting is to turn on `ntfyalert`, and set `ntfytopic` a unique topic if you are not selfhosting ntfy._

```text
# ntfy Alerts | https://docs.linuxgsm.com/alerts/ntfy
ntfyalert="on"
ntfytopic="your-topic-name" # Defaults to "LinuxGSM", you should use something unique.
ntfyserver="selfhosted-ntfy-url" # Defaults to "https://ntfy.sh", set if self-hosting ntfy.
ntfypriority=""
ntfytags=""

# If publishing to topics behind auth: https://docs.ntfy.sh/publish/#authentication
ntfytoken=""
ntfyusername=""
ntfypassword=""
```