Adjust Documentation

systemli · Jun 23, 2024 · 298f712 · 298f712
1 parent 2325cc8
commit 298f712
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/config.yml.dist b/config.yml.dist
@@ -16,8 +16,7 @@ telegram:
 # signal group configuration
 signal_group:
   api_url: ""
-  api_user: "signal-cli"
-  api_pass: ""
+  avatar: ""
   account: ""
 # listen port for prometheus metrics exporter
 metrics_listen: ":8181"

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -15,7 +15,12 @@ database:
 secret: "slorp-panfil-becall-dorp-hashab-incus-biter-lyra-pelage-sarraf-drunk"
 # telegram configuration
 telegram:
-  token: ""
+  token: "" # telegram bot token
+# signal group configuration
+signal_group:
+  api_url: "" # URL to your signal cli (https://github.com/AsamK/signal-cli)
+  avatar: "" # URL to the avatar for the signal group
+  account: "" # phone number for the signal account
 # listen port for prometheus metrics exporter
 metrics_listen: ":8181"
 upload:
@@ -39,6 +44,9 @@ The following env vars can be used:
 * `TICKER_INITIATOR`
 * `TICKER_SECRET`
 * `TICKER_TELEGRAM_TOKEN`
+* `TICKER_SIGNAL_GROUP_API_URL`
+* `TICKER_SIGNAL_GROUP_AVATAR`
+* `TICKER_SIGNAL_GROUP_ACCOUNT`
 * `TICKER_METRICS_LISTEN`
 * `TICKER_UPLOAD_PATH`
 * `TICKER_UPLOAD_URL`
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -126,6 +126,9 @@ func LoadConfig(path string) Config {
 	if os.Getenv("TICKER_SIGNAL_GROUP_ACCOUNT") != "" {
 		c.SignalGroup.ApiUrl = os.Getenv("TICKER_SIGNAL_GROUP_ACCOUNT")
 	}
+	if os.Getenv("TICKER_SIGNAL_GROUP_AVATAR") != "" {
+		c.SignalGroup.ApiUrl = os.Getenv("TICKER_SIGNAL_GROUP_AVATAR")
+	}
 
 	return c
 }