11. ngcp-faxserver system configuration

The fax solution is available in Pro and Carrier only

update /etc/ngcp-config/config.yml with the correct fax options

faxserver:
  enable: yes
  fail_attempts: '3'
  fail_retry_secs: '60'
  mail_from: 'Sipwise NGCP FaxServer <voipfax@ngcp.sipwise.local>'

update /etc/ngcp-config/templates/etc/ngcp-faxserver/faxserver.conf.tt2 with the correct fax options under the "User templates" section
ngcpcfg apply configured fax server
ngcpcfg push

sip:provider PRO mail server (Exim in this case) must be configured to receive emails from outside as by default Exim listens on the local interface only
run "dpkg-reconfigure exim4-config" to adjust Exim configuration
DNS must be configured with a subdomain starting as mail2fax.yourcompany.com, that is where the faxes will be sent by users to trigger "mail2fax" or alternatively, edit /etc/ngcp-config/templates/etc/exim4/conf.d/router/999_mail2fax.tt2 and adjust it to your personal preferences

On the GUI interface (ngcp-panel) Subscribers → Preferences
Look up "Fax Features" section where there are two subsections, "Fax2Mail and Sendfax" and "Mail2Fax".

"To" header must contain sip:provider PRO plaftorm subscriber’s number
"Subject" header must contain the fax destination number
"Body" should consist of text data and/or PDF attachement(s)
To use "Secret key" it should be either put in the first row of the body followed by an empty line or included as a text attachement. Once recognized it is removed from the email. Note: add "Secret" in either the body or as an attachement, do not add both as only one is recognized and removed, leaving the other one to be sent as a part of the fax.

Example:

assuming there is a subscriber on sip:provider PRO platform with number 43130111 and the destination fax is 43130222 and "Secret key" is "MySecretKey"

To: 43130111
Subject: 43130222

MySecretKey

This is a test fax.

Cheers

Incoming fax, find a fax machine, then dial the corresponding phone/fax number, you should be able to receive the email
Outgoing fax, login to the subscriber self-care interface and send a fax from there
Mail2Fax, send an email to the configured "mail2fax" subscriber