Docs

client/client.yml

@@ -5,14 +5,25 @@
 #
 # default-host: https://ntfy.sh
 
-# Subscriptions to topics and their actions. This option is only used by the "ntfy subscribe --from-config"
-# command.
+# Subscriptions to topics and their actions. This option is primarily used by the systemd service,
+# or if you cann "ntfy subscribe --from-config" directly.
 #
-# Here's a (hopefully self-explanatory) example:
-#   subscribe:
-#     - topic: mytopic
-#       command: /usr/local/bin/mytopic-triggered.sh
-#     - topic: myserver.com/anothertopic
-#       command: 'echo "$message"'
+# Example:
+#     subscribe:
+#       - topic: mytopic
+#         command: /usr/local/bin/mytopic-triggered.sh
+#       - topic: myserver.com/anothertopic
+#         command: 'echo "$message"'
+#
+# Variables:
+#     Variable        Aliases         Description
+#     --------------- --------------- -----------------------------------
+#     $NTFY_ID        $id             Unique message ID
+#     $NTFY_TIME      $time           Unix timestamp of the message delivery
+#     $NTFY_TOPIC     $topic          Topic name
+#     $NTFY_MESSAGE   $message, $m    Message body
+#     $NTFY_TITLE     $title, $t      Message title
+#     $NTFY_PRIORITY  $priority, $p   Message priority (1=min, 5=max)
+#     $NTFY_TAGS      $tags, $ta      Message tags (comma separated list)
 #
 # subscribe:

client/config.go

@@ -7,12 +7,12 @@ const (
 
 // Config is the config struct for a Client
 type Config struct {
-	DefaultHost string
+	DefaultHost string `yaml:"default-host"`
 	Subscribe   []struct {
-		Topic   string
-		Command string
+		Topic   string `yaml:"topic"`
+		Command string `yaml:"command"`
 		// If []map[string]string TODO This would be cool
-	}
+	} `yaml:"subscribe"`
 }
 
 // NewConfig creates a new Config struct for a Client