From ef68815294b3cf20f20a64cd9afc3dc979ab1767 Mon Sep 17 00:00:00 2001 From: terminaldweller Date: Sun, 3 Nov 2024 12:10:45 -0500 Subject: added the new option, ircchannelpass to the readme --- README.md | 10 ++++++---- docker-compose.yaml | 1 - 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index eb2927d..cadbc47 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,15 @@ I have a made blogpost about it [here](https://blog.terminaldweller.com/posts/ho ### Features -* The IRC bot supports SASL plain authentication.
-* The webhook endpoint itself supports HTTP basic authentication.
-* The webhook has [pocketbase](https://github.com/pocketbase/pocketbase) integrated so you can use that to create new users.
+- The IRC bot supports SASL plain authentication.
+- The webhook endpoint itself supports HTTP basic authentication.
+- The webhook has [pocketbase](https://github.com/pocketbase/pocketbase) integrated so you can use that to create new users.
**_Note_**: Last but not least, you will need a forwarding agent that actually sends the SMS you get on your android device to the webhook endpoint.
Currently [this](https://github.com/bogkonstantin/android_income_sms_gateway_webhook) is what I'm using to forward my SMS to the webhook. Also make sure the app settings on android are changed accordingly because the forwarder needs to run in the background so make sure android does not battery-optimize it out of existence.
### Config + An example config file: ```toml @@ -24,12 +25,13 @@ IrcNick = "mynick" IrcSaslUser = "mynick" IrcSaslPass = "h4x0r1337p055w0rd" IrcChannel = "1337p17" +IrcChannelPass = "mychannelpassword" ``` - ### Deployment A docker compose file is available for a quick setup: + ```yaml version: "3.9" services: diff --git a/docker-compose.yaml b/docker-compose.yaml index 587876a..3ad9a2e 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,4 +1,3 @@ -version: "3.9" services: sms-webhook: image: sms-webhook -- cgit v1.2.3