ClearFoundation

This is a work in progress... I'll be editing it as we go. I've included links to appropriate resources to help flesh out the information.

Warning
I've put a fair bit of detail into this tutorial, but it does require that you know how to use webconfig, the terminal and WinSCP or a similar method to transfer files to your box.

Picking a Modem
This is a critical part of your setup. I have wasted a lot of time with bad modems, so choose carefully. If possible, I recommend an external serial modem. We've used MultiModem ZBA Serial units and they've worked the best for us. We also have a few low-powered boxes running older ISA modems with success.

www.hylafax.org/content/Handbook:Basic_S...ion:Choosing_a_Modem

Get Hylafax
Download the Hylafax RPMs from the following. I usually download them on a Windows PC and then transfer them using WinSCP or a flash drive

www.hylafax.org/content/Red_Hat_Packages

Prepare your ClearOS box
Make sure you have the SMTP server installed on your ClearOS box. This will allow you to easily have incoming faxes e-mailed to your FaxMaster and your inbox.

Install the Hylafax RPMs
Once you have the RPMs on your ClearOS box, go to the directory they're stored in and then execute them with the following commands.



You will likely be prompted to install sharutils and ghostscript as Hylafax requires them. To install them just issue the following command:



After you run the installation, it will automatically run /usr/sbin/faxsetup and then /usr/sbin/faxaddmodem to configure HylaFax. Just answer the questions as best you know how - aside from the phone number-related questions you can likely select the defaults.

Your modem will likely be ttyS0 or ttyS1, but if those don't work keep going up until HylaFax finds it... you'll know that it works when HylaFax asks you to identify it as a Class 1 or Class 2 modem. 99% of the time you'll want to select Class 1 (even if it is a Class 2 modem)

Further Configuration
Add the following to to /etc/inittab where ttySx is the name of your /dev device [ie. fax modem] used in faxsetup and faxaddmodem



Restart init using the following command:



Mail Configuration
Using webconfig configure and start up the SMTP Server on your ClearOS box. If it's a dedicated fax server I suggest you add your domain in the Mail Forward List or add your mail server to the Outbound Relay Hosts. If you do configure it this way make sure that the hostname on the box is not set to your domain name, but instead to something like system.clearos.lan

Set up an Alias in the Aliases webconfig page to redirect FaxMaster to youraddress@yourdomain.com. This is where all warnings as well as incoming faxes will be sent. If you would like incoming mail to be sent elsewhere you need to modify the SENTO= line in /etc/hylafax/etc/FaxDispatch

Client Software Configuration
Configure Hylafax to talk to client software so that you can send out faxes through it. It is necessary to specify which client machines and users can have access to a HylaFAX™ server machine. This is specified by the contents of the /etc/hylafax/etc/hosts.hfaxd file ion the server machine. A simple way to allow access is to add the IPs of users that will be faxing through the server.

www.hylafax.org/content/Handbook:Basic_S...ration:Client_Access

Set up your fax client software
Now you can install and configure your fax software so that you can print to the Fax machine and view faxes. The ones we've used most are YajHFC, WHFC and Frog FaxMail. For a basic configuration you should configure the following parameters:

1. Server Name (or IP)
2. Username (shows up in logs)
3. E-mail Address (for fax status notifications)

www.hylafax.org/content/Desktop_Client_Software

Further References
www.hylafax.org/content/Handbook:Binary_...nstall#Red_Hat_Linux
www.hylafax.org/content/Documentation
www.hylafax.org/content/Handbook:Basic_S...Periodic_Maintenance

Great post - thanks!

This has been my most painless installation of a hylafax server ever !
Thank you very much!

In order to speed up the installation you may want to download the packages directly to the clearos box using (from console), as an example for the x86 arch do :



wget works even with ftp links and you will save the hassle of using winscp.

Fernand,

Very nice work here! And a big thank you! We should see if this would be a module that others would desire. Wishlist time!

Michael Proper

easy, out of the box, fax server capability is a really important feature to my opinion for most enterprises that are not covered by their PBX for fax needs.

Hi Fernand,

Thanks for this great post. I'm having one issue and I was wondering if you could lend me a hand. I've followed your tutorial and I'm using a Multi-Tech Systems MT5634ZBA-V92/1.32b external serial modem. I've been unable to successful send or receive faxes and I've tried setting it as a Class 1, 1.0 and 2.1 modem. The Hylafax server recognizes it but nothing works.

The following error appears in /var/log/messages when I try to send or receive a fax:

FaxGetty[29069]: ANSWER: Ring detected without successful handshake

The following is logged in /etc/hylafax/log/c000000181

Jul 17 21:24:39.16: [29069]: SESSION BEGIN 000000181 18109853102
Jul 17 21:24:39.16: [29069]: HylaFAX (tm) Version 6.0.4
Jul 17 21:24:39.16: [29069]: <-- [4:ATA\r]
Jul 17 21:24:39.17: [29069]: --> [5:ERROR]
Jul 17 21:24:39.17: [29069]: ANSWER: Ring detected without successful handshake
Jul 17 21:24:39.17: [29069]: Ring detected without successful handshake
Jul 17 21:24:39.17: [29069]: SESSION END

I've searched the Hylafax mailing list and there are plenty of people who have had this same issue but no one has posted a successful solution or even a good explanation of what causes that error.

Have you experienced this error before? Will you tell me the model number of the exact Multi-Tech serial modem you've had success with please?

Thanks for any help you can give.

What are the contents of /var/spool/hylafax/etc/config.PORT_NAME ?
Have you tested with another modem, as stated above hylafax is somehow picky on modems ...

Thanks for the reply.

I haven't tested with another modem. The modem and ClearBOX are at a remote location and there is a tech on site who purchased and installed the modem for the client. The really strange thing is that some people on the Hylafax list absolutely love this modem. There have been a few who just have not been able to get it to work.

Here are the contents of the modem's config file:

[root@gw1 ~]# cat /etc/hylafax/etc/config.ttyS0
# $Id$

#
# prototype config for MultiTech 5634-series modems using
# the Lucent/Agere chipset supporting V.34-Fax.
#

#
CountryCode: "1 "
AreaCode: "xxx "
FAXNumber: +1.xxx.xxx.xxx
LongDistancePrefix: 1
InternationalPrefix: 011
DialStringRules: etc/dialrules
ServerTracing: 32783
SessionTracing: 0xffff
RecvFileMode: 0600
LogFileMode: 0600
DeviceMode: 0600
RingsBeforeAnswer: 1
SpeakerVolume: off
GettyArgs: "-h %l dx_%s"
LocalIdentifier: "NothingSetup"
TagLineFont: etc/lutRS18.pcf
TagLineFormat: "From %%l|%c|Page %%P of %%T"
MaxRecvPages: 25
NotifyCmd: bin/notify.php

ModemReadyCmds: AT+VDR=0,0 <--------- I got this from the mailing list

# AT+FAA=1 isn't sufficient with the current MT5634ZBA-V92. <--------- I got this from the mailing list
ModemSetupAACmd: AT%A1+FAA=1 <--------- I got this from the mailing list
ModemWaitForConnect: yes <--------- I got this from the mailing list

ModemType: Class1.0 # use this to supply a hint
ModemRate: 57600 # must be at least as fast as the DCE-DCE communication
ModemFlowControl: rtscts # many firmwares have broken software flow control
Class1EnableV34Cmd: AT+F34=14,1,2 # 33600-2400 primary, 2400-1200 control
Class1TMConnectDelay: 400 # counteract quick CONNECT response
Class1HasRHConnectBug: yes # cope with +FRH=3 CONNECT errors

# If your line supports Caller-ID, you may want to uncomment this...
# ModemResetCmds: AT+VCID=1
# CallIDPattern: "NMBR="
# CallIDPattern: "NAME="

# Or with the MT5634ZBA-DID you'll probably need something like...
# ModemReadyCmds: AT*DS1*DD0*DF1*DN4 # enable DTMF-DID, wink-start, 4 digits
# CallIDPattern: "DTMF" # format of AT*DF1
# CallIDAnswerLength: 4 # four DTMF-DID digits then ATA

[root@gw1 ~]#

I did not configure fax to email part, but getting email "bounced" error. Why?

Installed and configured IAXmodem =Ok
Installed and configured hylafax = OK
Purposely skipped part for fax to emal delivery.
Tested.
Can receive faxes just fine.
But on delivery postfix tries to email them and they are bounced with error message: status=bounced (user unknown)

and I don't use Kolab or horde at all

Any way to tell postfix not to deliver faxes?
I checked main.cf, master.cf, transport, virtual, and generic and there is nothing that could have triggered delivery.

I am not sure if I understand your problem, but you need to edit /etc/aliases and include this line :


And then, from console type :


Other than that check that your overall smtp configuration is working ok.