Leistungsmerkmal Faxserver

Beschreibung Leistungsmerkmal

LocaPhone stellt für Empfang und Versand von Fax verschiedene Dienste bereit.

Fax kann empfangen (fax2email) und gesendet (email2fax) werden per E-Mail, über das Webinterface, oder durch zusätzliche Fax-Clientsoftware. Status-Informationen für die Fax-Übertragung werden per E-Mail an den Benutzer zugestellt, bzw. sind im Webinterface oder in der Fax-Clientsoftware sichtbar.

Je nach Anbindung von LocaPhone mittels SIP-Trunk oder Mediengateway ISDN/analog an das Telefonnetz kann die Übertragung per Codec G.711 oder T.38 erfolgen. Die Anzahl der gleichzeitig verfügbaren Fax-Übertragungen (Fax-Modems) ist konfigurierbar.

Fax-Nummer(n)

• Bereitstellung von einzelnen Nebenstellen für den Faxempfang

• Bereitstellung Fax-Mailboxen je Benutzer mit Präfix vor Nebenstellen-Nummern

• interner Fax-Versand/Emfpang mit nicht-öffentlichen Rufnummern (intern z.B. '*96' oder 'fax-' als Parameter FAX_PREFIX)

Fax-Empfang

• Zustellung als E-Mail mit PDF-Anhang an Benutzer (fax2email)

• Darstellung und Verwaltung im Webinterface

• Zustellung bei Nutzung eines Fax-Clients

Fax-Versand

• Hochladen einer PDF-/Text-Datei im Webinterface

• Setzen von verschiedenen Absenderkennungen bei Versand per Webinterface

• Anzahl Versuche Fax-Versand konfigurierbar (bei Versand per Webinterface)

• Versand bei Nutzung eines Fax-Clients

• optional: per E-Mail mit PDF-Anhang/Text (Leistungsmerkmal email2fax)

Fax-Verwaltung

• Verwalten von Fax in Webinterface

• Verwalten von Fax in zusätzlicher Fax-Clientsoftware

Optionale Funktionen (nicht Teil des Leistungsumfangs von LocaPhone)

• automatische Verwendung von Deckblättern

• Einbinden von Druckern (CUPS) als Abteilungsdrucker

• automatische Ausgabe von Fax auf Drucker

• Faxserver auf separatem Host bei großer Anzahl Fax-Übertragungen

Benutzung Leistungsmerkmal

Das Leistungsmerkmal stellt verschiedene Wege zur Verwaltung von Fax bereit.

• Web-UI Fax - Webinterface-Menüpunkt für Empfang/Versand

• Empfang per E-Mail mit PDF-Attachment

• Versand per E-Mail (benötigt Leistungsmerkmal Faxserver email2fax)

• Fax-Clientsoftware - Software-Clients für HylaFax

Voraussetzungen

Nach entsprechender Systemkonfiguration wird im Webinterface der Menüpunkt Fax aktiviert.

Installation

Die folgenden Konfigurationsschritte setzen die passende Berechtigung (root) des Benutzer-Accounts auf dem LocaPhone-Server voraus!

apt-get install hylafax-client hylafax-server t38modem

t38modem ist aus dem Paketrepository http://ubuntu.loca.net nur mit einer gültigen Kundennummer (als Benutzername) und dem dazugehörigen Master-Passwort aus der LocaNet-Kundendatenbank abrufbar!

Konfiguration Fax-System (fax2email)

Die Funktionen für Fax-Dienste werden über die zentrale Konfigurationsdatei des TK-Systems sowie über Gruppen-Berechtigungen konfiguriert.

Datei /etc/locaphone/locaphone.php

/***********************************************************
*    FAX
***********************************************************/

$FAX_ENABLED            = false;
//$FAX_PREFIX             = '*96';  # e.g. "*96" or "6"
  # internally faxes can be sent to <FAX_PREFIX><extension>
//$FAX_TSI_PREFIX         = '02501234';
//$FAX_TSI_PREFIX         = @$CANONIZE_NATL_PREFIX . @$CANONIZE_AREA_CODE . @$CANONIZE_LOCAL_BRANCH;
//$FAX_TSI                = '025012340,02501234100,0250123499';
//$FAX_TSI                = @$FAX_TSI_PREFIX.'0,' . @$FAX_TSI_PREFIX.'100,' . @$FAX_TSI_PREFIX.'99';
  # (TSI = Transmitting Subscriber Identification)

//$FAX_HYLAFAX_HOST       = '127.0.0.1';
//$FAX_HYLAFAX_PORT       = 4559;          # HylaFax port (FTP-like protocol)
//$FAX_HYLAFAX_ADMIN      = '';            # Adds admin user to your HylaFax's "hosts.hfaxd"
//$FAX_HYLAFAX_PASS       = '';

//$FAX_INIT_FROM_NET         = '192.168.0.0/16, 172.16.0.0/12, 10.0.0.0/8, 169.254.0.0/16, 127.0.0.0/8';
  # a comma (,) separated list of IP addresses or
  # <IP address>/<netmask> pairs from where fax calls can be inited with HTTP GET
  # CIDR or dotted decimal notation
  # e.g.: '127.0.0.1, 192.168.1.130/255.255.255.0, 192.168.1.130/24'
  # allow all: '0.0.0.0/0', allow none: '0.0.0.0/32'

//$FAX_INIT_DOCDIR         = '/tmp/';
  # directory containing fax documents to be used by "send-fax.php"
  
//$FAX_WEBFAX_MAXTRIES = 6;
  # Make no more than `FAX_WEBFAX_MAXTRIES` attempts to send the facsimile.
  # This only effects facsimiles that have been sent by the web UI.

//$FAX_WEBFAX_MAXDIALS = 6;
  # Make no more than `FAX_WEBFAX_MAXDIALS` calls in attempting to send the facsimile.
  # This only effects facsimiles that have been sent by the web UI.

//$FAX_DEVICES = "";
  # a semicolon separated list of sip peers that may be us to receive facsimiles
  
//$FAX_DEVICE_SECRET = "justASecRetPwD";
  # sip password for all sip peers defined in `FAX_DEVICES`

¹ Man kann Fax-Durchwahlen für alle Benutzer festlegen, indem man für alle internen Durchwahlen einen Präfix definiert. Lässt man diesen leer, so ist der Fax-Dienst direkt auf der einzelnen Durchwahl verfügbar. Für den Benutzer-basierten Fax-Versand besteht die Absender-Kennung des Fax aus der Kombination des Präfix und der Benutzerdurchwahl.

² Es können noch zusätzliche Absender-Kennungen (auswählbar in der Web-UI beim Fax-Versand) festgelegt werden. Wenn mehrere Nummern zur Auswahl stehen sollen, so müssen diese durch ein Komma getrennt werden.

³ LocaPhone kann mit mehrere Instanzen von t38-Modem umgehen. Diese müssen sich jeweils einzeln am Vermittlungskern registrieren. SIP-Peers müssen LocaPhone bekannt gegeben werden (z.B.: faxdev01-faxdev04). Mehrere Instanzen müssen durch Semikolon voneinander getrennt werden.

⁴ Alle SIP-Peers für den Faxempfang benutzen zur Registrierung am Vermittlungskern das gleiche Passwort.

Nach Änderung der Einträge in der zentralen Konfigurationsdatei ist der Dialplan neu zu generieren, und der Vermittlungskern neu zu laden.

/opt/locaphone/sbin/gs-ast-dialplan-reload --generate
/opt/locaphone/sbin/gs-hylafax-auth-update
asterisk -rx 'sip reload'

Gruppen-Berechtigungen

Jeder Benutzer, der über das LocaPhone-System ein Fax versenden/emfpangen soll, muss in einer Benutzergruppe mit der Berechtigung fax_recipient sein.

Je nach Konfiguration des Systems (FAX_PREFIX) kann es zu Überschneidungen von Benutzer-Durchwahlen mit Fax-Durchwahlen kommen, die auch durchaus gewollt sein können. Beachtet man dieses Verhalten nicht, kann dies dazu führen, dass bestimmte Nebenstellen nicht mehr erreichbar sind.

Es gilt: eine Fax-Durchwahl wird vor einer Benutzer-Durchwahl im Dialplan ausgewertet!

Beispiel-Konfiguration

¹ Zustellung erfolgt NUR bei hinterlegter E-Mail-Adresse des Benutzers in der Benutzerverwaltung.
² Eine eventuell vorhandene Nebenstelle 921 ist nicht mehr erreichbar, da die Fax-Durchwahl Vorrang vor der Benutzer-Durchwahl hat!

Konfiguration Fax-System T38modem

Die Anbindung des Fax-Systems an den Vermittlungskern erfolgt mit virtuellen Fax-Modems (T38modem). Zur Konfiguration von einem oder mehreren virtuellen Modems T38modem wird im Verzeichnis /etc/default/ für jedes Fax-Modem eine Konfigurationsdatei t38modem-[Devicename] angelegt. Im Verzeichnis /etc/default/ liegt eine Beispieldatei t38modem als Basis.

cp /etc/default/t38modem  /etc/default/t38modem-ttyT38MODEM0
cp /etc/default/t38modem  /etc/default/t38modem-ttyT38MODEM1
cp /etc/default/t38modem  /etc/default/t38modem-ttyT38MODEM2
cp /etc/default/t38modem  /etc/default/t38modem-ttyT38MODEM3

Jedes erzeugte Fax-Modem (t38modem-ttyT38MODEMx) muss einzeln konfiguriert werden!

Datei/etc/default/t38modem

# /etc/default/t38modem
# t38modem configuration, edit first and copy to t38modem-%ttyname% for each t38modem instance

# SIP server/registrar
T38MODEM_SIP_SERVER=127.0.0.1

# SIP port of server/registrar
T38MODEM_SIP_PORT=5060

# Authuser for registration to server
T38MODEM_SIP_USER=faxdev01

# Authuser's password
T38MODEM_SIP_PASS=justASecRetPwD

# Local port t38modem should use for communication
T38MODEM_SIP_LOCAL_PORT=5160

Jedes erzeugte Fax-Modem muss einen eigenen SIP-Port (T38MODEM_SIP_LOCAL_PORT) verwenden! Im obigen Beispiel mit vier Instanzen werden die Ports 5160 bis 5163 verwendet.

Das Aktiviern der Fax-Modems erfolgt händisch oder bei mehreren Instanzen z.B. mittels Script:

Datei enable_fax.sh

#!/bin/bash
for i in {0..3} ; do
systemctl enable --system t38modem@ttyT38MODEM${i}
systemctl start t38modem@ttyT38MODEM${i}
done

Die Instanzen der Fax-Modems sind danach am Vermittlungskern registriert. Bei Problemen kann es sinnvoll sein, die Fax-Modems neu zu starten (siehe auch System Dienst Fax Neustart).

Konfiguration T38modem bis LocaPhone Version 5.0.0

Für LocaPhone bis Version 5.0.0 ist der folgende Block in der Datei t38modem@.service hinzuzufügen.

Datei/lib/systemd/system/t38modem@.service

[Install]
WantedBy=multi-user.target

Diese Änderungen sind in späteren Versionen von LocaPhone bereits enthalten!

Konfiguration Fax-System HylaFAX

Für die Applikation HylaFAX werden von LocaPhone die entsprechenden Konfigurationsdateien bereitgestellt, die in die passenden Systemverzeichnisse zu kopieren sind.

cp /usr/share/doc/locaphone5.0-core/misc/fax-integration/config /etc/hylafax/
cp /usr/share/doc/locaphone5.0-core/misc/fax-integration/t38modem/config.ttyT38MODEM /etc/hylafax/
cp /usr/share/doc/locaphone5.0-core/misc/fax-integration/t38modem/FaxDispatch /etc/hylafax/

Für die Fax-Modems ist die Datei config.ttyT38MODEM umzubenennen und zu duplizieren, sodass für jede Instanz eines Fax-Modems die entsprechende Datei vorhanden ist.

mv /etc/hylafax/config.ttyT38MODEM /etc/hylafax/config.ttyT38MODEM0
cp /etc/hylafax/config.ttyT38MODEM0 /etc/hylafax/config.ttyT38MODEM1
cp /etc/hylafax/config.ttyT38MODEM0 /etc/hylafax/config.ttyT38MODEM2
cp /etc/hylafax/config.ttyT38MODEM0 /etc/hylafax/config.ttyT38MODEM3

Für das Fax-Modem faxdev01 (= T38MODEM0) sind dann entsprechend die Dateien /etc/default/t38modem-ttyT38MODEM0 und /etc/hylafax/config.ttyT38MODEM0 vorhanden.

Die folgenden Einstellungen als Berechtigungen für das Faxsystem sind zusätzlich vorzunehmen.

echo "uucp ALL = NOPASSWD: /bin/chgrp" > /etc/sudoers.d/hylafax   # User uucp darf als root /bin/chgrp ausführen
chmod 0440 /etc/sudoers.d/hylafax
touch /var/spool/hylafax/log/dispatch.log						  # logfile erstellen
chown uucp:uucp /var/spool/hylafax/log/dispatch.log				  # logfile User zuweisen

Hinzufügen der Parameter in Datei /etc/hylafax/hfaxd.conf zum Setzen der Berechtigung, sodass jeder Benutzer nur seine gesendeten/empfangenen Fax-Daten einsehen kann.

Datei/etc/hylafax/hfaxd.conf

# user job permission
JobProtection: 0600
PublicJobQ:    false
PublicRecvQ:   false

Damit HylaFAX gestartet werden kann, müssen in der Datei /etc/default/hylafax die folgenden Einstellungen vorgenommen werden.

Datei/etc/default/hylafax

RUN_HYLAFAX=1		# automatischer Start (default =0)
USE_FAXGETTY=init   # faxgetty-Prozesse mit systemd verwalten (nicht mit HylaFAX Start-Script)

Neustart HylaFAX nach Änderung der Konfiguration des Systems.

systemctl stop hylafax
systemctl start hylafax

Die Konfiguration des Leistungsmerkmals Faxserver ist damit abgeschlossen.

Konfiguration Hylafax bis LocaPhone Version 4.2.1

Für LocaPhone bis Version 4.2.1 ist die Datei /etc/hylafax/FaxDispatch anzupassen. In Zeile 23 müssen die Zugangsdaten für einen SQL-Benutzer hinterlegt werden, der lesend auf die Tabelle 'users' der Datenbank 'asterisk' zugreifen darf. Dieser Zugriff wird benötigt, um die Benutzer-ID des Empfängers festzustellen und um die E-Mail-Adresse für den Faxversand zu bestimmen. Im Beispiel sind es hier „dbuser“ als Benutzername und „dbpass“ als Passwort.

Datei/etc/hylafax/FaxDispatch

SQL_RESULT=$(mysql --user=dbuser --password=dbpass -hlocalhost -Dasterisk --execute="SELECT \`u\ ....

Diese Änderungen sind in späteren Versionen von LocaPhone bereits enthalten!

Formate

Verwendete Datei-Formate für Faxübertragungen:

Ereignisanzeige

Datei /var/spool/hylafax/log/dispatch.log

Ereignisanzeige Zustellung Übertragungen

Abhängigkeiten

Damit Fax als E-Mail an Benutzer zugestellt werden kann, wird auf dem LocaPhone-System ein Mail Transfer Agent (siehe System Dienst MTA) benötigt. Dieser liefert die vom Faxsystem erstellten E-Mails an ein Empfänger-System aus. Für die Zustellung wird ein Zugang zu einem E-Mail-System (SMTP-Relay) oder E-Mail-Postfach benötigt.

Das Faxsystem von LocaPhone basiert auf HylaFAX+. Für die Verbindung zum Vermittlungskern des LocaPhone-Systems werden virtuelle Fax-Modems mit T38.Modem bereitgestellt.

Zusätzliche Informationen

Für Faxübetragung relevante Dateien werden im Dateisystem des LocaPhone-Servers abgelegt.

Weiteres

Fax-Clientsoftware

• Java Fax-Client https://www.yajhfc.de

• Windows Faxclient (http://sourceforge.net/projects/wphf-reloaded/) für Versand von MS Office-Dokumenten

Information zum Faxsystem HylaFAX

• https://legacy.hylafax.org/man/current/hylafax-server.4f.html

• https://www.hylafax.org/hylafax-handbook/

• https://www.hylafax.org/faq/

• http://the-asterisk-book.com/1.6/faxserver-mit-iaxmodem-und-hylafax.html

• https://legacy.hylafax.org/site1/

• https://legacy.hylafax.org/site2/