diff --git a/source/_integrations/signal_messenger.markdown b/source/_integrations/signal_messenger.markdown index fd2c57fc372c..d5e4ded59992 100644 --- a/source/_integrations/signal_messenger.markdown +++ b/source/_integrations/signal_messenger.markdown @@ -63,6 +63,19 @@ url: description: The URL where the Signal Messenger REST API listens for incoming requests. required: true type: string +auth: + description: Configuration for basic authentication + required: false + type: map + keys: + username: + description: Username for authentication. + required: true + type: string + password: + description: Password for authentication. + required: true + type: string number: description: The sender number. required: true @@ -75,6 +88,23 @@ recipients: type: string {% endconfiguration %} +### Basic authentication + +If Signal Messenger is running behind a proxy that requires basic authentication, you need to add `auth` to your configuration and specify the username and password. + +```yaml +# Basic authentication example for Signal Messenger +notify: + - name: signal + platform: signal_messenger + url: "http://127.0.0.1:8080" + auth: + username: "BASIC_AUTH_USERNAME" # the username to be used for Basic Auth + password: "BASIC_AUTH_PASSWORD" # the password for the specified user + number: "YOUR_PHONE_NUMBER" + recipients: + - "RECIPIENT1" +``` ## Notification action