FAX Server

Description

This module installs and configures the fax server software

Release notes

Show release notes
Version 2.8.1 - Early deployment
  • Bugfix: restore missing directory for fax server users (TS-13)
  • Dependency:
    • Baseline >= 2.0.0 AND Baseline < 3.0.0
    • SOP Base >= 1.5.4
    • Shell Module >= 1.23.0
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.8.0 - Deprecated
  • Improvement: removed resource intensive defence script (PC-109)
  • Deprecated: restore missing directory for fax server users (TS-13)
  • Dependency:
    • Baseline >= 2.0.0 AND Baseline < 3.0.0
    • SOP Base >= 1.5.4
    • Shell Module >= 1.23.0
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.7.0 - Early deployment
  • Improvement: Removed dependency with safetynet (M21023)
  • Dependency:
    • Baseline >= 2.0.0 AND Baseline < 3.0.0
    • SOP Base >= 1.5.4
    • Shell Module >= 1.23.0
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.6.1 - Early deployment
  • Bugfix: Caller ID was not always present in email's subject (M16958)
  • Dependency:
    • Baseline >= 2.0.0 AND Baseline < 3.0.0
    • SOP Base >= 1.5.4
    • Shell Module >= 1.23.0
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.6.0 - Early deployment
  • Feature: Convert plugins to new library model (M14774)
  • Bugfix: Compatibility with escaux user (M16876)
  • Potential update impact level 1 DONE: no critical impact expected. Update can be applied without risk of breaking critical functionality.: You will have to upgrade the Shell module and other modules too. Please verify the release notes of the Shell module 1.23.0 to find out which modules need to be upgraded. (M14774)
  • Dependency:
    • Baseline >= 2.0.0 AND Baseline < 3.0.0
    • SOP Base >= 1.5.4
    • Shell Module >= 1.23.0
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.5.1 - Early deployment
  • Bugfix: Caller ID was not always present in email's subject (Backport) (M16958)
  • Dependency:
    • Baseline 1.x or Baseline 2.x
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.5.0 - Early deployment
  • Feature: Support for PNG/GIF/BMP/JPG in html email body (M13957)
  • Dependency:
    • Baseline 1.x or Baseline 2.x
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.4.2 - Deprecated
  • Bugfix: Add additional supported content types for PDF files for email to fax (M13793)
  • Improvement: Allow disabling the body of the message (M13807)
  • Deprecated: The apply-sop-change was not working properly (M0)
  • Dependency:
    • Baseline 1.x or Baseline 2.x
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.4.1 - Deprecated
  • Bugfix: email notifications for faxes are not sent in the user's language (M13458)
  • Deprecated: The apply-sop-change was not working properly (M0)
  • Dependency:
    • Baseline 1.x or Baseline 2.x
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.4.0 - Deprecated
  • Feature: Included translations for Spanish, French, Dutch, Italian and German. (M0012862)
  • Deprecated: The apply-sop-change was not working properly (M0)
  • Dependency:
    • Baseline 1.x or Baseline 2.x
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.3.2 - Early deployment
  • Bugfix: Add additional supported content types for PDF files for email to fax - backport (M13793)
  • Bugfix: Allow disabling the body of the message - backport (M13807)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.3.1 - Early deployment
  • Bugfix: Apply extension change could render en empty FaxDispatch file (M11314)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.3.0 - General deployment
  • Feature: When using a virtual fax extension combined with STARTDYNAMICAPPLICATION, you can now customize the header caller id using the fax Number. (M9668)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.2.5 - General deployment
  • Bugfix: default values were incorrect when upgrading from a previous version and new options are available. (M10261)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.2.4 - General deployment
  • Bugfix: Add cleanup of previous config to the postsync script(M6704)
  • Bugfix: Email with Context-ID generate a hylafax error (M9345)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.2.3 - General deployment
  • Feature: Caller ID name and Caller ID number is now set to whatever is set in the module when sending a fax. (M6769)
  • Bugfix: When number of phones was set to 0, a wrong value was created in the configuration file (M7977)
  • Improvement: Make email dispatching more robust to invalid characters (M7875)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.3.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.2.2 - General deployment
  • Bugfix: Some packages were copied to the wrong installation directory
  • Bugfix: Charset not correctly recognized with some mail clients
  • Bugfix: Octet-stream not correctly recognized
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.2.1 - General deployment
  • Bugfix: Characters encoding not correctly recognized (M7487)
  • Feature: Support of octet-stream for mail-to-fax attached PDFs (M0)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.2.0 - General deployment
  • Bugfix: Special characters not correctly transcoded in html and plain/text documents(M7334)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.1.1 - General deployment
  • Bugfix: corrected installation problem in case of an upgrade (M00007213)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.1.0 - General deployment
  • Bugfix: The process that converts the received fax to a pdf file sometimes crashed (M0006435)
  • Feature: Checks if documents are valid when using email-to-fax. (M0006315)
  • Feature: Support inline HTML images when using mail to fax (M0006661)
  • Feature: FAX server notification mail attachment is now limited to the first page (M0006438)
  • Feature: Failure notification is sent for incorrect/unknown fax extension for email-to-fax (M0006899)
  • Limitation: in case of an upgrade, the module must be installed twice. (M00007213)
  • Dependency:
    • SOP Base >= 1.5.4
    • Mail Server Module >= 1.3.2
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.0.3 - General deployment
  • Bugfix: FAX server 2 would not start if Caller ID Name contained a space. Dependencies were updated. (M0006274)
  • Dependency:
    • System Base >= 1.0.0
    • Mail Server Module >= 1.1.4
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.0.2 - General deployment
  • Feature: Support 'Fine' quality when sending email-to-fax. (M0005925)
  • Dependency:
    • Mail Server Module >= 1.1.4
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.0.1 - General deployment
  • Improvement: Allow custom notification address.
  • Dependency:
    • Mail Server Module >= 1.1.4
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 2.0.0 - General deployment
  • Feature: Post installation action step was removed. (M0004892)
  • Feature: Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations. Updated core binaries of the Fax Server.
  • Feature: You can now install the module with 0 channels, which means that the fax server is disabled.
  • Bugfix: Caller ID Name was overwritten in some cases when doing post install (M0005264)
  • Bugfix: Invalid mail sender address is used when module not configured properly (M0005365)
  • Dependency:
    • Mail Server Module >= 1.1.4
    • Watchdog Module >= 1.1.0
    • STARTFAXAPPLICATION >= 3.10

Version 1.10.3 - General deployment
  • Bugfix: iaxmodem processes not launched automatically after the module installation (M6509)
  • Dependency:
    • Mail Server Module >= 1.1.3
    • Watchdog >= 1.0.3
    • STARTFAXAPPLICATION >= 3.10

Version 1.10.2 - General deployment
  • Improvement: Allow custom notification address.
  • Dependency:
    • Mail Server Module >= 1.1.3
    • Watchdog >= 1.0.3
    • STARTFAXAPPLICATION >= 3.10

Version 1.10.1 - General deployment
  • Bugfix: Caller ID Name was overwritten in some cases when doing post install (M0005264)
  • Dependency:
    • Mail Server Module >= 1.1.3
    • Watchdog >= 1.0.3
    • STARTFAXAPPLICATION >= 3.10

Version 1.10.0 - General deployment
  • Feature: Support basic HTML in email-to-fax. (M0004716)
  • Dependency:
    • Mail Server Module >= 1.1.3
    • Watchdog >= 1.0.3
    • STARTFAXAPPLICATION >= 3.10

Version 1.9.0 - General deployment
  • Improvement: Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations. Ensure that pincode is taken in account in all cases. (M0005031)
  • Bugfix: Fixed notifications on baseline 1. (M0005365)
  • Bugfix: Installation procedure fails for baseline 1.
  • Dependency:
    • Mail Server Module >= 1.1.1
    • Watchdog >= 1.0.3
    • STARTFAXAPPLICATION >= 3.10

Version 1.8.6 - Deprecated
  • Improvement: Fax notifications, remove Unneeded URL (M0004658)
  • Deprecated: Installation procedure fails for baseline 1.
  • Dependency:
    • Mail Server Module >= 1.1.1
    • Watchdog >= 1.0.3

Version 1.8.5 - Deprecated
  • Improvement: Fax notifier does not notify for each re-queued fax
  • Feature: Support for reports (M0004660)
  • Feature: Added actions from service assurance guide into SOP Shell
  • Deprecated: Installation procedure fails for baseline 1.
  • Dependency:
    • Mail Server Module >= 1.1.1
    • Watchdog >= 1.0.3

Version 1.8.4 - Deprecated
  • Bugfix: Fixed watchdog behavior
  • Deprecated: Installation procedure fails for baseline 1.
  • Dependency:
    • Mail Server Module >= 1.1.1
    • Watchdog >= 1.0.3

Version 1.8.3 - Deprecated
  • Bugfix: Fixed watchdog behavior
  • Improvement: Enable 8 fax channels on fax server for baseline 2.x (M0004206)
  • Deprecated: Installation procedure fails for baseline 1.
  • Dependency:
    • Mail Server Module >= 1.1.1
    • Watchdog >= 1.0.3

Version 1.8.2 - Deprecated
  • Bugfix: Fix faxadduser and faxdeluser in baseline1 and baseline2
  • Feature: Added Watchdog script that relaunches the fax server if an anomaly is detected
  • Deprecated: Installation procedure fails for baseline 1
  • Dependency:
    • Mail Server Module >= 1.1.1

Version 1.8.1 - Deprecated
  • Feature: Email to fax is now supported for baseline 2 installations (M3818)
  • Deprecated: Installation procedure fails for baseline 1.
  • Dependency:
    • Mail Server Module >= 1.1.1

Version 1.8.0 - Deprecated
  • Feature: Added support for Baseline 2 (M0003103)
  • Improvement: Hylafax is now restarted correctly
  • Improvement: Number of iaxmodem is always 4
  • Deprecated: Installation procedure fails for baseline 1.

Version 1.7.0 - General deployment
  • Feature: Allow restarting of the faxserver from the Escaux shell
  • Improvement: Filetype defaults to PDF

Version 1.6.0 - General deployment
  • Feature: Allow selection of domain name to send received faxes from during post-installation
  • Feature: Allow selection of the received filetype (tiff or pdf)

Version 1.5.0 - General deployment
  • Bugfix: Changed the location of the configuration files (/etc/hylafax/ instead of /var/spool/hylafax/etc)
  • Improvement: Added the callerid presentation field
  • Improvement: hylafax will automatically restart after an upgrade. The server doesn't need a reboot anymore.

Version 1.4.0 - General deployment
  • Upgraded iaxmodem

Version 1.3.0 - General deployment

Version 1.2.0 - General deployment

Version 1.1.0 - General deployment

Module configuration interface

create_resource_form: .:/usr/share/escaux/glue/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib/

Number of fax channels
Domain
Filetype (default: PDF)
Caller ID Name
Caller ID Number
Send Email Body (Email to fax)

Module parameters

Fax Server 1.0

  • Number of fax channels: Sets up the number of fax channels, be sure to add the appropriate number of iaxmodems. (Baseline 1 only supports up to 4 channels)
  • Caller ID presentation: Caller presentation information to be inserted in sent faxes. The value is a comma separated list containing the caller name and the caller number
  • Domain: Domain name to send received faxes from. Gives the option to modify the domain the mails are sent from. This should be the FQDN.
  • File type: Content of the fax will be presented in this file format.

Fax Server 2.0

  • Number of fax channels: Sets up the number of fax channels, be sure to add the appropriate number of iaxmodems. (Baseline 1 only supports up to 4 channels)
  • Domain: Domain name to send received faxes from. Gives the option to modify the domain the mails are sent from. This should be the FQDN.
  • File type: Content of the fax will be presented in this file format.
  • Caller ID Name: Your caller name. This value will be present on your fax headers.
  • Caller ID Number: Your caller number. This value will be present on your fax headers.

Module post-installation

Fax Server 1.x

Launch the post-installation tasks trough the SOP Shell.

DONE Navigate to:  Configuration > Hylafax > Post Installation

And launch an apply-changes on the SMP.

Fax Server 2.x

Launch an apply-changes on the SMP.

Installation procedure

In order to have a functional fax server installing this module is not enough, some additional parametrization is required. To install the fax solution please follow the step by step installation procedure in the administration guide.

If you also want to send faxes, you can use any of those clients:

Architecture

Fax communication are degraded by VoIP transmission. It is not recommended or supported to have fax communication on any VoIP link.

If VoIP must be used due to lack of alternatives, make sure you minimize the VoIP link:
  • If you use a separate SOP as a gateway, the fax server should be installed on this gateway.
  • If you use a gateway for incoming calls and a gateway for outgoing calls, the fax server should be installed on the gateway which handles incoming calls. Make sure you check that the ISDN operator sends all new incoming calls to this gateway (with the other gateway as backup)

Fax modem specifications

  • Class: Class1
  • Group: Group 3
  • Modulation Type: V.27ter (PSK) and V29 (QAM) for reception. V.27ter (PSK), V29 (QAM) and V.17 (TCM) for transmission.
  • Error Correction: T.30-A error correction protocol.
  • Compression mechanisms: Modified Read, Modified Modified Read, for sending and receiving.
  • Transmission speeds: 2400 bits/s, 4800 bits/s, 7200 bits/s and 9600 bits/s for reception. 2400 bits/s, 4800 bits/s, 7200 bits/s, 9600 bits/s, 12000 bits/s and 14400 bits/s for transmission.
  • Resolutions : R8x3.85 l/mm (Normal), R8x7.7 l/mm (Fine), R8x15.4 l/mm (Superfine) and R16x15.4 l/mm (Hyperfine)
Copyright © Escaux SA