diff --git a/README.md b/README.md index 06eb393..2607658 100644 --- a/README.md +++ b/README.md @@ -80,29 +80,23 @@ Sim: {sim} ### SMS handler app configuration -Set the *Webhook URL* with as `https://your.server.name:8025/sms-handle`. +Set the *Webhook URL* to `http://your.server.name:8025/handle-sms`. -*Note*: the URI path `/sms-handle` is not configurable. +Adjust with the public name (`your.server.name`) and the port where the +service is exposed. This corresponds to the +`--port` option of `sms-handler`. See also the *Reverse proxy* note below. + +*Note*: the URI path `/handle-sms` is not configurable. ## Run -### In foreground - -```sh -sms-handler -``` - -Set port and listen address: - -```sh -sms-handler --port 80125 --host 192.168.100.55 -``` - ### As a daemon (Systemd) Create a service as below, adapt the email addresses (`snoopy@peanuts.com` in this example). -Settings for the web server (listen address and port) are given in the ExecStart statement. +Settings for the web server (listen address and port) can be given +in the ExecStart statement if the default values need to be adapted. + Other parameters are given as environment variables (see above). ```systemd @@ -146,6 +140,22 @@ my.example.com { Replace the public host name `my.example.com` and the destination IP:port `127.0.0.1:8025` for your setup. +### In foreground + +A service like `sms-handler` is designed to run as a background service (daemon).the + +However it is possible to run it manually: + +```sh +sms-handler +``` + +Set port and listen address: + +```sh +sms-handler --port 80125 --host 192.168.100.55 +``` + ## Development and test *sms-handler* is packaged with [uv](https://docs.astral.sh/uv/). @@ -166,7 +176,7 @@ The *sms-handler* source includes a CI test workflow for [Forgejo](https://forge ## Compatibility *sms-handler* is also compatible with -[this fork of *SMS to URL Forwarder*](>https://github.com/scottmconway/android_income_sms_gateway_webhook) +[this fork of *SMS to URL Forwarder*](https://github.com/scottmconway/android_income_sms_gateway_webhook) which includes also the sender's name. ## Alternatives