Skip to content

gotify.md

Latest commit

 

History

History
59 lines (39 loc) · 1.59 KB

gotify.md

File metadata and controls

59 lines (39 loc) · 1.59 KB

Gotify Notification Setup

This guide will walk you through setting up Gotify notifications. You will learn how to obtain the necessary credentials and configure them in your environment.

1. Get Gotify URL and App Token

First, you need to get the Gotify server URL and an app token.

  1. Gotify Server URL: This is the URL of your Gotify server.
  2. App Token: You can create a new app in the Gotify web UI and get the token.

2. Configure Chatz

Next, you need to configure Chatz to use the Gotify provider. You can do this by editing the ~/.chatz.ini file or by setting environment variables.

Using ~/.chatz.ini

Add the following section to your ~/.chatz.ini file:

[gotify]
PROVIDER=gotify
GOTIFY_URL=<your-gotify-server-url>
GOTIFY_TOKEN=<your-gotify-app-token>
GOTIFY_TITLE=<your-gotify-title>
GOTIFY_PRIORITY=<your-gotify-priority>

Using Environment Variables

Set the following environment variables:

export PROVIDER=gotify
export GOTIFY_URL=<your-gotify-server-url>
export GOTIFY_TOKEN=<your-gotify-app-token>
export GOTIFY_TITLE=<your-gotify-title>
export GOTIFY_PRIORITY=<your-gotify-priority>

3. Send a Test Notification

Now you can send a test notification to your Gotify server.

chatz --profile=gotify "Hello from Chatz!"

You should receive a notification on your Gotify server.

Using CLI Flags

You can also override the title and priority using CLI flags:

chatz --profile=gotify --subject "Custom Title" --priority 7 "Hello from Chatz!"

This will send a notification with "Custom Title" as the title and a priority of 7.