From 8956837443985d55e454e48dbb4407f715bc5daa Mon Sep 17 00:00:00 2001
From: Hunter Kehoe <hunter.kehoe@gmail.com>
Date: Sun, 31 Jul 2022 13:12:15 -0600
Subject: [PATCH 1/3] add default-user, default-password, and default-command
options to client.yml config
---
client/config.go | 14 ++++++++++----
client/config_test.go | 10 +++++++++-
cmd/subscribe.go | 27 ++++++++++++++++++++++++---
3 files changed, 43 insertions(+), 8 deletions(-)
diff --git a/client/config.go b/client/config.go
index 0866cd1b..2bbe9d51 100644
--- a/client/config.go
+++ b/client/config.go
@@ -12,8 +12,11 @@ const (
// Config is the config struct for a Client
type Config struct {
- DefaultHost string `yaml:"default-host"`
- Subscribe []struct {
+ DefaultHost string `yaml:"default-host"`
+ DefaultUser string `yaml:"default-user"`
+ DefaultPassword string `yaml:"default-password"`
+ DefaultCommand string `yaml:"default-command"`
+ Subscribe []struct {
Topic string `yaml:"topic"`
User string `yaml:"user"`
Password string `yaml:"password"`
@@ -25,8 +28,11 @@ type Config struct {
// NewConfig creates a new Config struct for a Client
func NewConfig() *Config {
return &Config{
- DefaultHost: DefaultBaseURL,
- Subscribe: nil,
+ DefaultHost: DefaultBaseURL,
+ DefaultUser: "",
+ DefaultPassword: "",
+ DefaultCommand: "",
+ Subscribe: nil,
}
}
diff --git a/client/config_test.go b/client/config_test.go
index d601cdb4..240d5ac7 100644
--- a/client/config_test.go
+++ b/client/config_test.go
@@ -12,6 +12,9 @@ func TestConfig_Load(t *testing.T) {
filename := filepath.Join(t.TempDir(), "client.yml")
require.Nil(t, os.WriteFile(filename, []byte(`
default-host: http://localhost
+default-user: phil
+default-password: mypass
+default-command: 'echo "Got the message: $message"'
subscribe:
- topic: no-command-with-auth
user: phil
@@ -22,12 +25,16 @@ subscribe:
command: notify-send -i /usr/share/ntfy/logo.png "Important" "$m"
if:
priority: high,urgent
+ - topic: defaults
`), 0600))
conf, err := client.LoadConfig(filename)
require.Nil(t, err)
require.Equal(t, "http://localhost", conf.DefaultHost)
- require.Equal(t, 3, len(conf.Subscribe))
+ require.Equal(t, "phil", conf.DefaultUser)
+ require.Equal(t, "mypass", conf.DefaultPassword)
+ require.Equal(t, `echo "Got the message: $message"`, conf.DefaultCommand)
+ require.Equal(t, 4, len(conf.Subscribe))
require.Equal(t, "no-command-with-auth", conf.Subscribe[0].Topic)
require.Equal(t, "", conf.Subscribe[0].Command)
require.Equal(t, "phil", conf.Subscribe[0].User)
@@ -37,4 +44,5 @@ subscribe:
require.Equal(t, "alerts", conf.Subscribe[2].Topic)
require.Equal(t, `notify-send -i /usr/share/ntfy/logo.png "Important" "$m"`, conf.Subscribe[2].Command)
require.Equal(t, "high,urgent", conf.Subscribe[2].If["priority"])
+ require.Equal(t, "defaults", conf.Subscribe[3].Topic)
}
diff --git a/cmd/subscribe.go b/cmd/subscribe.go
index 94c11b4d..2c737870 100644
--- a/cmd/subscribe.go
+++ b/cmd/subscribe.go
@@ -175,11 +175,32 @@ func doSubscribe(c *cli.Context, cl *client.Client, conf *client.Config, topic,
for filter, value := range s.If {
topicOptions = append(topicOptions, client.WithFilter(filter, value))
}
- if s.User != "" && s.Password != "" {
- topicOptions = append(topicOptions, client.WithBasicAuth(s.User, s.Password))
+ var user, password string
+ if s.User != "" {
+ user = s.User
+ } else if conf.DefaultUser != "" {
+ user = conf.DefaultUser
+ } else {
+ user = ""
+ }
+ if s.Password != "" {
+ password = s.Password
+ } else if conf.DefaultPassword != "" {
+ password = conf.DefaultPassword
+ } else {
+ password = ""
+ }
+ if user != "" && password != "" {
+ topicOptions = append(topicOptions, client.WithBasicAuth(user, password))
}
subscriptionID := cl.Subscribe(s.Topic, topicOptions...)
- cmds[subscriptionID] = s.Command
+ if s.Command != "" {
+ cmds[subscriptionID] = s.Command
+ } else if conf.DefaultCommand != "" {
+ cmds[subscriptionID] = conf.DefaultCommand
+ } else {
+ cmds[subscriptionID] = ""
+ }
}
if topic != "" {
subscriptionID := cl.Subscribe(topic, options...)
From f6a42e7dcd8a0c9ee014dbad1d2d940d6fa19111 Mon Sep 17 00:00:00 2001
From: Hunter Kehoe <hunter.kehoe@gmail.com>
Date: Sun, 31 Jul 2022 16:40:07 -0600
Subject: [PATCH 2/3] add docs explaining default-user, default-password,
default-command
---
docs/subscribe/cli.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/subscribe/cli.md b/docs/subscribe/cli.md
index 03d9132a..f1f9e760 100644
--- a/docs/subscribe/cli.md
+++ b/docs/subscribe/cli.md
@@ -254,6 +254,14 @@ I hope this shows how powerful this command is. Here's a short video that demons
<figcaption>Execute all the things</figcaption>
</figure>
+If most (or all) of your subscription usernames, passwords, and commands are the same, you can specify a `default-user`, `default-password`, and `default-command` at the top of the
+`client.yml`. If a subscription does not specify a username/password to use or does not have a command, the defaults will be used, otherwise, the subscription settings will
+override the defaults.
+
+!!! warning
+ Because the `default-user` and `default-password` will be sent for each topic that does not have its own username/password (even if the topic does not require authentication),
+ be sure that the servers/topics you subscribe to use HTTPS to prevent leaking the username and password.
+
### Using the systemd service
You can use the `ntfy-client` systemd service (see [ntfy-client.service](https://github.com/binwiederhier/ntfy/blob/main/client/ntfy-client.service))
to subscribe to multiple topics just like in the example above. The service is automatically installed (but not started)
From 613d5d554f766b8f9f815dc48b010aa29ea6e269 Mon Sep 17 00:00:00 2001
From: Hunter Kehoe <hunter.kehoe@gmail.com>
Date: Sun, 31 Jul 2022 16:46:56 -0600
Subject: [PATCH 3/3] add example config for default-user, default-password,
default-command
---
client/client.yml | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/client/client.yml b/client/client.yml
index 56733a14..3cd5736c 100644
--- a/client/client.yml
+++ b/client/client.yml
@@ -5,6 +5,12 @@
#
# default-host: https://ntfy.sh
+# Defaults below will be used when a topic does not have its own settings
+#
+# default-user:
+# default-password:
+# default-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.
#