HylaFAX HowTo

Author:  Darrell May <dmay@myezserver.com>
Contributor:
  
Release supported: => SME 6.x
Last updated:
10/15/2004 4:07 PM

 


Problem:  You wish to use HylaFAX on SME Server
Solution:
  Follow this HowTo :-)


 

The HylaFAX server is a complex install requiring multiple rpms installed, HylaFAX setup programs executed and SME configuration changes.  Please follow this HowTO closely.  I also strongly recommend you use an external modem on COM1/ttyS0.

For detailed HylaFAX information please visit the HylaFAX web site and these documents:

http://www.hylafax.org/setup.html
http://www.hylafax.org/howto/index.html
http://www.hylafax.org/troubleshooting.html
http://www.hylafax.org/support.html


STEP 1: Installing HylaFAX

HylaFAX is installed in two stages.  

STAGE 1: download and install the latest smeserver-hylafax-pkg-x.x.x-x.noarch.rpm

# rpm -Uvh smeserver-hylafax-4.x.x-x.noarch.rpm

This installs numerous rpms into /opt/smeserver-hylafax-pkg

STAGE 2: run the install.sh script to load the rpms

# cd /opt/smeserver-hylafax-pkg
# sh ./install.sh


STEP 2:  Configuring HylaFAX

STAGE 1: Using faxsetup to configure the HylaFAX server

Before HylaFAX can be used on a server the faxsetup script must be run. This interactive script verifies the installation of the HylaFAX software and also carries out a variety of one-time tasks and then writes configuration information in to two files in the HylaFAX spooling area.

# /usr/sbin/faxsetup

STAGE 2: Using faxaddmodem to configure the modem

Modems are configured for use with the faxaddmodem script. This is an interactive script that walks you through the configuration and installation of a new or existing modem. Even if you have a previous version of HylaFAX installed it is a good idea to run faxaddmodem to update the configuration information for your modems after installing a new distribution. Faxaddmodem may be run directly from the command line or via the faxsetup script that is used to prepare a server machine for use with HylaFAX.

# /usr/sbin/faxaddmodem ttyS0 -s 19200

 

There are a number of prompted parameters to set. Most are either self explanatory or defaults suffice. Here are some key parameters where defaults should be changed:

 

Protection mode for received facsimile [0600]? 0644

Protection mode for session logs [0600]? 0666

Protection mode for ttyS0 [0600]? 0644

 


 
Step 3: Add HylaFAX Users

The HylaFAX server will only accept client requests from users that match a userlist that you define.  To add users to the userlist run the HylaFAX faxadduser command.  Simply enter the username of every person that will be granted the right to send a fax.  This username must match the username in the WHFC HylaFAX client software.

# /usr/sbin/faxadduser username


Step 4: FaxMaster alias

HylaFAX defaults to using an alias named faxmaster and sends all received faxes to faxmaster@yourdomain.com.  In the SME  server-manager, either create a user faxmaster or using the pseudonym panel add the pseudonym faxmaster to the user you wish to receive all faxes.


Step 5: SME configuration entries for HylaFAX

The default SME configuration entries for HylaFAX are as follows:

FileType = pdf

This is the received fax attachment file type. Options are pdf, tif, ps

SendTo = FaxMaster

This is the alias/username of the fax receptionist

TTY = ttyS0

This is your modem port such as ttyS0, ttyS1 etcetera

Note the default settings are automatically used in the templates.  Default settings are not visible in /home/e-smith/configuration.  Only custom settings will be displayed.  Normally the default settings work just fine.  To implement custom settings (defaults shown) use the following db commands:

# /sbin/e-smith/config setprop hylafax FileType pdf
# /sbin/e-smith/config setprop hylafax SendTo FaxMaster
# /sbin/e-smith/config setprop hylafax TTY ttyS0


STEP 6: Starting HylaFAX

When all the above installation and set up changes are completed, issue the hylafax-update command to update and restart HylaFAX:

# /sbin/e-smith/signal-event hylafax-update


HylaFAX clients:

Please visit this link to see a list of known HylaFAX client programs:

http://www.hylafax.org/links.html#clients

My personal preference for a Windows HylaFAX client is WHFC available here:

http://www.uli-eckhardt.de/whfc/