Difference between revisions of "HylaFax"
(Fixed typo) |
|||
(52 intermediate revisions by 14 users not shown) | |||
Line 1: | Line 1: | ||
− | == | + | {{Languages|HylaFax}} |
− | http://www.hylafax.org | + | ==HylaFAX for SME Server== |
− | HylaFAX is an enterprise-class system for sending and receiving facsimiles as well as for sending alpha-numeric pages. | + | {{Level|Advanced}} |
+ | === Version === | ||
+ | {{ #smeversion: smeserver-hylafax}} | ||
+ | |||
+ | ===Maintainer=== | ||
+ | http://www.dungog.net<br /> | ||
+ | |||
+ | ===Description=== | ||
+ | [http://www.hylafax.org HylaFAX] is an enterprise-class system for sending and receiving facsimiles as well as for sending alpha-numeric pages. | ||
The software is designed around a client-server architecture. Fax modems may reside on a single machine on a network and clients can submit an outbound job from any other machine on the network. | The software is designed around a client-server architecture. Fax modems may reside on a single machine on a network and clients can submit an outbound job from any other machine on the network. | ||
− | + | ===Documentation=== | |
− | http://www.hylafax.org/content/Handbook | + | [http://www.hylafax.org/content/Handbook HylaFAX Handbook] |
+ | |||
+ | ===Installation=== | ||
+ | ====SME8==== | ||
+ | |||
+ | |||
+ | yum --enablerepo=smecontribs install smeserver-hylafax | ||
+ | then issue | ||
+ | |||
+ | signal-event post-upgrade; signal-event reboot | ||
+ | |||
+ | ====SME9==== | ||
+ | you might need to install dag repo : https://wiki.contribs.org/Dag#tab=For_SME_9 | ||
+ | |||
+ | yum --enablerepo=smecontribs,smedev,dag install smeserver-hylafax | ||
+ | |||
+ | then you need to issue: | ||
+ | /sbin/e-smith/expand-template /etc/hylafax/hyla.conf | ||
+ | /sbin/e-smith/expand-template /etc/init/ttyS0.conf | ||
+ | /bin/rm -f /etc/cron.daily/hylafax | ||
+ | signal-event post-upgrade; signal-event reboot | ||
− | === | + | ====SME10==== |
+ | you might need to install epel repo: | ||
− | + | yum install smeserver-extrarepositories-epel | |
− | + | then | |
− | |||
− | + | yum --enablerepo=smecontribs,{epel} install smeserver-hylafax | |
− | + | ===Enable Hylafax to start at boot (SME8 and 9 only)=== | |
+ | config setprop hylafax status enabled | ||
− | ====Configure | + | ====Configure==== |
− | Make sure that your modem is plugged into the serial port and turned on | + | Make sure that your modem is plugged into the serial port and turned on, then run |
/usr/sbin/faxsetup | /usr/sbin/faxsetup | ||
− | Answer the questions as required. | + | Answer the questions as required. <br> |
− | Accept the defaults on most everything except | + | Accept the defaults on most everything except <br> |
− | the county & area code and telephone number of the fax line. | + | the county & area code and telephone number of the fax line. <br> |
+ | |||
+ | Take note of your modems port <br> | ||
+ | |||
+ | The inittab template assumes you are using ttyS0 <br> | ||
+ | see options below for how to change to ttyS1 <br> | ||
− | + | For SME8 or SME9: | |
− | + | You can modify your answers later, see below <br> | |
+ | then | ||
+ | signal-event post-upgrade; signal-event reboot | ||
+ | or | ||
+ | /etc/rc.d/init.d/hylafax [start | restart] | ||
+ | /sbin/e-smith/expand-template /etc/inittab | ||
+ | /sbin/init q | ||
− | + | To Disable | |
− | + | /etc/rc.d/init.d/hylafax stop | |
+ | config setprop hylafax status disabled | ||
+ | expand-template /etc/inittab | ||
+ | /sbin/init q | ||
− | + | for SME10: | |
+ | signal-event smeserver-hylafax-update | ||
− | |||
− | |||
− | |||
− | |||
− | + | To Remove | |
+ | rpm -e hylafax smeserver-hylafax | ||
− | + | ====Usage==== | |
− | + | {{Note box|SMERPFax should be added to smecontribs, and/or panels should be converted to utf-8, perhaps it should be merged with smeserver-hylafax}} | |
− | |||
− | a | + | Optional, Download this contrib: http://smerp.free.fr/fichiers/binaires/SMERPFax-0.8b1-1.noarch.rpm |
− | + | The SMERPFax-contrib from Christian Dumont gives you a configurable panel to Hylafax! | |
+ | You can download the english version .pdf Manual [http://smerp.free.fr/fichiers/documentations/SMERPFAx.documentation.en.us.pdf here] | ||
===Usage=== | ===Usage=== | ||
====Receiving faxes by e-mail==== | ====Receiving faxes by e-mail==== | ||
− | All incoming faxes go to the faxmaster' | + | All incoming faxes go to the user '''faxmaster''', or forwarded as you have configured. Forwarding can be configured in /etc/hylafax/etc/FaxDisptach |
====Sending faxes by e-mail==== | ====Sending faxes by e-mail==== | ||
− | One of the main uses for | + | One of the main uses for HylaFAX is as an e-mail to fax gateway. This gateway unifies a users |
communications, so that faxing is as simple as using an e-mail client. The user can e-mail | communications, so that faxing is as simple as using an e-mail client. The user can e-mail | ||
− | john@08812345678.fax and know that the message typed, and any attachment will be faxed via | + | john@08812345678.fax and know that the message typed, and any attachment will be faxed via HylaFAX. |
− | To setup an e-mail to fax gateway using | + | To setup an e-mail to fax gateway using HylaFAX, a few simple scripts are needed to convert attachments into postscript so that HylaFAX can then use them. By default you can send e-mails with pdf attachments, postscript attachments or tiff attachments. |
Testing | Testing | ||
Send an e-mail from your favorite mailing software to the SME-Server. This means that the smtp server in your e-mail software must be set to the SME-Server. Because the e-mail address we are going to be using will only be known by our server. Then we will send an e-mail with the following recepeint: Name@FaxNumber.fax | Send an e-mail from your favorite mailing software to the SME-Server. This means that the smtp server in your e-mail software must be set to the SME-Server. Because the e-mail address we are going to be using will only be known by our server. Then we will send an e-mail with the following recepeint: Name@FaxNumber.fax | ||
− | |||
e.g: John_Smith@5555551212.fax | e.g: John_Smith@5555551212.fax | ||
Line 80: | Line 120: | ||
* Don't expect your html formatted e-mails to be faxed! Sorry! | * Don't expect your html formatted e-mails to be faxed! Sorry! | ||
− | + | ====HylaFAX clients==== | |
− | ==== | ||
Download Client Software from: | Download Client Software from: | ||
Line 87: | Line 126: | ||
* http://www.frogfax.com/modules/spxnews/ | * http://www.frogfax.com/modules/spxnews/ | ||
* http://www.hylafax-client.de | * http://www.hylafax-client.de | ||
− | + | * http://www.hyfax.com/j/index.php | |
Login on your SME Server with ssh and make new faxusers: | Login on your SME Server with ssh and make new faxusers: | ||
Line 93: | Line 132: | ||
faxadduser -p password2 username2 | faxadduser -p password2 username2 | ||
− | Install the | + | Install the HylaFAX Client, configure with these values: |
Server IP: Your SME Server IP | Server IP: Your SME Server IP | ||
Port: 4559 | Port: 4559 | ||
Username: above username | Username: above username | ||
Passord: above password | Passord: above password | ||
− | |||
− | |||
− | ports other than ttyS0, | + | ===Other Modifications and Customizations=== |
+ | |||
+ | ports other than ttyS0, or to disable | ||
+ | |||
+ | for SME8 and SME9: | ||
+ | |||
+ | config setprop hylafax status disabled | ||
config setprop hylafax port ttyS1 | config setprop hylafax port ttyS1 | ||
/sbin/e-smith/expand-template /etc/inittab | /sbin/e-smith/expand-template /etc/inittab | ||
/sbin/init q | /sbin/init q | ||
+ | |||
+ | for SME10: | ||
+ | |||
+ | config setprop hylafax port ttyS1 | ||
+ | signal-event smeserver-hylafax-update | ||
+ | |||
+ | |||
---- | ---- | ||
Change permissions and other settings in the config.MODEM file | Change permissions and other settings in the config.MODEM file | ||
− | nano -w /etc/hylafax/etc/config.ttyS0 | + | nano -w /etc/hylafax/etc/config.ttyS0 |
# make attachments readable | # make attachments readable | ||
Line 118: | Line 168: | ||
RingsBeforeAnswer: 10 | RingsBeforeAnswer: 10 | ||
# change to suit | # change to suit | ||
− | SpeakerVolume: | + | SpeakerVolume: quiet |
LocalIdentifier: "Pagen Vegan Pty Ltd" | LocalIdentifier: "Pagen Vegan Pty Ltd" | ||
+ | |||
+ | /etc/rc.d/init.d/hylafax restart | ||
+ | |||
+ | ---- | ||
+ | To be able to send a fax by mailfax with the latest version of HylaFax (4.4.x-y and further - see the post [http://forums.contribs.org/index.php/topic,42553.msg200708.html#msg200708] to see explained the problem you may encounter without modifications), edit the file: | ||
+ | nano -w /var/spool/hylafax/etc/mailfax | ||
+ | |||
+ | Comment out the following lines, like: | ||
+ | ### /usr/bin/faxmail -f Helvetica-Bold | /usr/bin/sendfax \ | ||
+ | ### -f "$SENDER" \ | ||
+ | ### -n -d "$EXT2@`/usr/bin/expr \"$HOST\" : '\(.*\)\.fax$'`" | ||
+ | |||
+ | Underneath the above lines add: | ||
+ | /usr/bin/faxmail -s a4 \ | ||
+ | -n -u uucp "$EXT2@`/usr/bin/expr \"$HOST\" : '\(.*\)\.fax$'`" \ | ||
+ | "$SENDER" | ||
+ | |||
+ | Further customizations are possible: | ||
+ | |||
+ | /usr/bin/faxmail -s a4 \ | ||
+ | -n -N -T -u uucp -t done "$EXT2@`/usr/bin/expr \"$HOST\" : '\(.*\)\.fax$'`" \ | ||
+ | "$SENDER" | ||
+ | |||
+ | -N -> this switch disable the faxmail Cover Page, otherwise autogenerated translating the mail header: this may be an "unuseful" cover with a mostly blank page; | ||
+ | |||
+ | -T -> this switch can disable empty blank pages at the end of your fax; | ||
+ | |||
+ | -t done -> in this way you can get your notification (receipt) concerning your fax transaction for both succesfull or failed faxes; this is a sample of the success message you'll receive in your mailbox: | ||
+ | |||
+ | Your job to 011654321 was completed successfully. | ||
+ | Pages: 1 | ||
+ | Receiver: 011 99988812 | ||
+ | Quality: 196 | ||
+ | Page Width: 209 (mm) | ||
+ | Page Length: 296 | ||
+ | Signal Rate: 9600 bit/s | ||
+ | Data Format: 2-D MMR | ||
+ | Remote Equipment: unknown | ||
+ | Remote Station: | ||
+ | Dialogs: 1 (exchanges with remote device) | ||
+ | Calls: 1 (total phone calls placed) | ||
+ | Modem: any | ||
+ | Submitted From: localhost | ||
+ | JobID: 28 | ||
+ | GroupID: 28 | ||
+ | CommID: c000000077 | ||
+ | Processing time was 1:07. | ||
+ | |||
+ | The fax is attached as a pdf file if not selected otherwise another file format. | ||
+ | |||
+ | {{Note box|In the previous commands the paper size is set to A4 with the '<tt>-s</tt>' option. Paper sizes that can be with this option are: | ||
+ | * <tt>NA-LET</tt> ''(US Letter)'' | ||
+ | * <tt>JP-LEG</tt> ''(Japanese legal)'' | ||
+ | * <tt>A4</tt> | ||
+ | Taken from: http://wiki.archlinux.org/index.php/Hylafax#Pagesize}} | ||
+ | |||
+ | === Bugs === | ||
+ | Please raise bugs under the SME-Contribs section in {{BugzillaFileBug|product=|component=|title=bugzilla}}and select the smeserver-hylafax component or use {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-hylafax|title=this link}}. | ||
+ | |||
+ | {{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |component=smeserver-hylafax|noresultsmessage="No open bugs found."}} | ||
+ | |||
+ | ===Changelog=== | ||
+ | Only released version in smecontrib are listed here. | ||
+ | |||
+ | {{ #smechangelog: smeserver-hylafax}} | ||
+ | |||
---- | ---- | ||
− | [[Category: | + | [[Category:Contrib]] |
+ | [[Category:Dungog]] | ||
+ | [[Category: Asterisk]] |
Latest revision as of 12:26, 15 October 2021
HylaFAX for SME Server
Version
Maintainer
Description
HylaFAX is an enterprise-class system for sending and receiving facsimiles as well as for sending alpha-numeric pages.
The software is designed around a client-server architecture. Fax modems may reside on a single machine on a network and clients can submit an outbound job from any other machine on the network.
Documentation
Installation
SME8
yum --enablerepo=smecontribs install smeserver-hylafax
then issue
signal-event post-upgrade; signal-event reboot
SME9
you might need to install dag repo : https://wiki.contribs.org/Dag#tab=For_SME_9
yum --enablerepo=smecontribs,smedev,dag install smeserver-hylafax
then you need to issue:
/sbin/e-smith/expand-template /etc/hylafax/hyla.conf /sbin/e-smith/expand-template /etc/init/ttyS0.conf /bin/rm -f /etc/cron.daily/hylafax signal-event post-upgrade; signal-event reboot
SME10
you might need to install epel repo:
yum install smeserver-extrarepositories-epel
then
yum --enablerepo=smecontribs,{epel} install smeserver-hylafax
Enable Hylafax to start at boot (SME8 and 9 only)
config setprop hylafax status enabled
Configure
Make sure that your modem is plugged into the serial port and turned on, then run
/usr/sbin/faxsetup
Answer the questions as required.
Accept the defaults on most everything except
the county & area code and telephone number of the fax line.
Take note of your modems port
The inittab template assumes you are using ttyS0
see options below for how to change to ttyS1
For SME8 or SME9:
You can modify your answers later, see below
then
signal-event post-upgrade; signal-event reboot
or
/etc/rc.d/init.d/hylafax [start | restart] /sbin/e-smith/expand-template /etc/inittab /sbin/init q
To Disable
/etc/rc.d/init.d/hylafax stop config setprop hylafax status disabled expand-template /etc/inittab /sbin/init q
for SME10:
signal-event smeserver-hylafax-update
To Remove
rpm -e hylafax smeserver-hylafax
Usage
Optional, Download this contrib: http://smerp.free.fr/fichiers/binaires/SMERPFax-0.8b1-1.noarch.rpm The SMERPFax-contrib from Christian Dumont gives you a configurable panel to Hylafax! You can download the english version .pdf Manual here
Usage
Receiving faxes by e-mail
All incoming faxes go to the user faxmaster, or forwarded as you have configured. Forwarding can be configured in /etc/hylafax/etc/FaxDisptach
Sending faxes by e-mail
One of the main uses for HylaFAX is as an e-mail to fax gateway. This gateway unifies a users communications, so that faxing is as simple as using an e-mail client. The user can e-mail john@08812345678.fax and know that the message typed, and any attachment will be faxed via HylaFAX.
To setup an e-mail to fax gateway using HylaFAX, a few simple scripts are needed to convert attachments into postscript so that HylaFAX can then use them. By default you can send e-mails with pdf attachments, postscript attachments or tiff attachments.
Testing
Send an e-mail from your favorite mailing software to the SME-Server. This means that the smtp server in your e-mail software must be set to the SME-Server. Because the e-mail address we are going to be using will only be known by our server. Then we will send an e-mail with the following recepeint: Name@FaxNumber.fax
e.g: John_Smith@5555551212.fax
- The name can be any name.
- The fax number is going to be used for faxing the document.
- Mail can only be send as a plain text e-mail.
- Mail can have a postscript, pdf or tiff attachment, this attachment will also be faxed.
- Don't expect your html formatted e-mails to be faxed! Sorry!
HylaFAX clients
Download Client Software from:
- http://www.hylafax.org/content/Client_Software
- http://www.frogfax.com/modules/spxnews/
- http://www.hylafax-client.de
- http://www.hyfax.com/j/index.php
Login on your SME Server with ssh and make new faxusers:
faxadduser -p password username faxadduser -p password2 username2
Install the HylaFAX Client, configure with these values:
Server IP: Your SME Server IP Port: 4559 Username: above username Passord: above password
Other Modifications and Customizations
ports other than ttyS0, or to disable
for SME8 and SME9:
config setprop hylafax status disabled config setprop hylafax port ttyS1 /sbin/e-smith/expand-template /etc/inittab /sbin/init q
for SME10:
config setprop hylafax port ttyS1 signal-event smeserver-hylafax-update
Change permissions and other settings in the config.MODEM file
nano -w /etc/hylafax/etc/config.ttyS0
# make attachments readable RecvFileMode: 0666 LogFileMode: 0666 DeviceMode: 0666 # for shared lines RingsBeforeAnswer: 10 # change to suit SpeakerVolume: quiet LocalIdentifier: "Pagen Vegan Pty Ltd"
/etc/rc.d/init.d/hylafax restart
To be able to send a fax by mailfax with the latest version of HylaFax (4.4.x-y and further - see the post [1] to see explained the problem you may encounter without modifications), edit the file:
nano -w /var/spool/hylafax/etc/mailfax
Comment out the following lines, like:
### /usr/bin/faxmail -f Helvetica-Bold | /usr/bin/sendfax \ ### -f "$SENDER" \ ### -n -d "$EXT2@`/usr/bin/expr \"$HOST\" : '\(.*\)\.fax$'`"
Underneath the above lines add:
/usr/bin/faxmail -s a4 \ -n -u uucp "$EXT2@`/usr/bin/expr \"$HOST\" : '\(.*\)\.fax$'`" \ "$SENDER"
Further customizations are possible:
/usr/bin/faxmail -s a4 \ -n -N -T -u uucp -t done "$EXT2@`/usr/bin/expr \"$HOST\" : '\(.*\)\.fax$'`" \ "$SENDER"
-N -> this switch disable the faxmail Cover Page, otherwise autogenerated translating the mail header: this may be an "unuseful" cover with a mostly blank page;
-T -> this switch can disable empty blank pages at the end of your fax;
-t done -> in this way you can get your notification (receipt) concerning your fax transaction for both succesfull or failed faxes; this is a sample of the success message you'll receive in your mailbox:
Your job to 011654321 was completed successfully. Pages: 1 Receiver: 011 99988812 Quality: 196 Page Width: 209 (mm) Page Length: 296 Signal Rate: 9600 bit/s Data Format: 2-D MMR Remote Equipment: unknown Remote Station: Dialogs: 1 (exchanges with remote device) Calls: 1 (total phone calls placed) Modem: any Submitted From: localhost JobID: 28 GroupID: 28 CommID: c000000077 Processing time was 1:07.
The fax is attached as a pdf file if not selected otherwise another file format.
Bugs
Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-hylafax component or use this link .
ID | Product | Version | Status | Summary |
---|---|---|---|---|
9490 | SME Contribs | 9.1 | CONFIRMED | import SMERPFAX panel to smeserver-hylafax rpm |
Changelog
Only released version in smecontrib are listed here.
- Add FaxDispatch confif file [SME: 11269]
2021/10/15 Brian Read 0.9-14.sme
- Add conf fragment for faxsetup fonts [SME: 11269]
- Reverse out release 12 changes. [SME: 11269]
- Add restart event without conf expand as faxsetup writes to it [SME: 11269]
- Add-Update-event-to-createlinks.patch [SME: 11269]