Enabling direct notifications

PhenixID server can act as an notification server. Main usage is sending messages to a user while logging in.

For instance pasword expiration is a common use case. In order to issue the actual message some other component must be the trigger. The module described here only works as an enabler for sending email or SMS.

Installing and configuring module

Open the store.json file with texteditor.

Locate the node id/hostname in the file onto witch you intend to install the module. Install the module by  adding:

{
      "module" : "com.phenixidentity~phenix-external-event~1.3.0",
      "enabled" : true,
      "config" : {
        "notify_sms" : {
          "connectionsettings" : {
            "username" : "<PhenixID message gateway username>",//leave empty to disable
            "password" : "<my super secret password>"//leave empty to disable
          }
        },
        "notify_email" : {
          "connectionsettings" : {
            "host" : "<smtp host>",
            "port" : "<port>",
            "sourceaddress" : "<from address>"
            "username" : "<SMPT_user_name>", //optional - leave empty for anon
            "password" : "<SMTP_password>", //optional - leave empty for anon
            "tlsenabled": "<true/false>", //optional (default true)
            "sslenabled": "<true/false>", //optional (default false)
            "verifyserveridentity": "<true/false>", //optional (default false)
          }
        }
      },
      
    }

To be able to use SMS as delivery method an account must be present at PhenixID message gateway.