Faximum Fax Server Software for Linux (IA32)
Mon Mar 24 13:44:13 PST 2003
for 2.0-35 (Linux)
Faximum Software Inc.
If you received this README file as a printed version in your software media kit it may be more current than the version on the media. Please use this version rather than the version on the CD-ROM. The most current copy is always available from http://www.faximum.com/support/readme/faximum-linux.html.
If you did not order a printed copy of the manuals for this product, you may obtain a PDF (i.e. Adobe Acrobat) version of the manual from the Faximum Software website at http://www.faximum.com/support/manuals
Please visit http://www.faximum.com/status for the latest news on this software release. This web page also contains information on any updates that might be released after this document was written.
This README has been written to be brief and to the point in order to expedite the installation of Faximum fax server software for Linux (running on 32-bit Intel Architecture systems) in the most common situations. Because the Faximum PLUS and Faximum Fax messaging Server (FMS) products share the same underlying fax engine and because in many situations it makes sense to purchase and install both products on the same machine (see below), there is a single installation file for all three products:
In the instructions below the sections specific to a single product will be so marked.
What's the Difference?
A more detailed explanation of the differences between Faximum ELS and Faximum PLUS may be found below. For a detailed description of the features of Faximum fax server software please visit http://www.faximum.com/info/
Why Would I Want Both FMS and PLUS?
As described above, Faximum PLUS fax-enables applications while Faximum FMS fax-enables users. Many organisations need to automate the faxing of documents from applications but also want their users to be able to send and receive faxes from their Windows desktops using the same fax server. Installing Faximum FMS and PLUS on the same system makes that possible. Please contact Faximum Sales for more information on the benefits of Faximum FMS+PLUS (see contact information at the beginning of this file).
Upgrading from Previous Versions
Please note that this version of the Faximum fax server software is designed for new installations only. It cannot be installed on top of an existing ELS, PLUS, or FMS installations. If you are running earlier releases of the Faximum fax server software in Linux then please contact email@example.com for special instructions on upgrading your installation.
The ELS/PLUS 4 has been designed by programmers for programmers. Faximum ELS/PLUS has always been popular with developers and customers for its ease of integration and its flexible and powerful options and utilities. But as more people started to do more with the product it became obvious that better methods of tracking requests and passing status information back to the originating application was needed. And it is in this area that the work on 4 has been concentrated. This includes an improved completion program feature which calls a programmer-specified program or shell script when the request is successful or fails passing much more detailed information on the request than in previous versions; and a new option to submitfax which allows an arbitrary id string to be associated with a request (this id string is passed to the completion program).
The other major enhancement was the replacement of the previous PCL-5 emulator with a new and much better PCL-5e emulator from another supplier. Not only does this new engine much more accurately emulate HP LaserJet printers, it supports more fonts, more commands, and HP/GL-2 (which was completely missing from our previous emulator).
Other features that have been added to produce Faximum ELS/PLUS 4:
* these features require additional support resources in order to exploit and therefore are only available to those who have purchased technical support contracts.
Faximum has a new product called the Faximum Messaging Server which provides email-to-fax and fax-to-email gateway services. Using FMS it is possible to send and receive faxes using your existing email client (on Windows, UNIX, or Linux). FMS can operate by itself (it includes a basic fax server) or it can be installed on top of Faximum PLUS. In such an integrated installation many of the PLUS features (styles, least-cost routing, call-detail recording, intelligent dialling, etc) become available to FMS users. For more information please see http://www.faximum.com/fms).
Migration Issues (applies to customers moving from Faximum ELS and PLUS on SCO OpenServer)
The following items were changes introduced in the previous release (2.2) but are worth repeating since they still apply:
The following items are changed in ELS & PLUS 4:
Faximum ELS & PLUS 5
If you have any suggestions for features you would like to see in future Faximum products and releases, please do email (firstname.lastname@example.org) or fax (1 604 926 8182) to us. We are always interested in learning how our customers and using our software and how we can improve the usefulness of our products.
ELS or PLUS -- Which is it and what's the diff?
Faximum ELS and Faximum PLUS are two of the products available from Faximum Software, Inc.
Documentation for ELS/PLUS
The updates to the "Faximum ELS/PLUS Reference Manual" are not complete at this time and so the product is shipping with the 2.x version of the manual. As most of the enhancements in Version 4 do not affect the interfaces documented in the Reference Manual, this ought not to cause any significant problems.
To browse or download a copy of most Faximum manuals please visit www.faximum.com/support/manuals
The new features added in this 4 release are documented in the following TechNotes:
Support for PostScript and PDF Documents
The GhostScript software and related integration components are not part of the Faximum ELS & PLUS software package but must be downloaded and installed separately. They are only needed if you wish to convert and fax PostScript or PDF (Adobe Acrobat) documents. If you have a Technical Support Contract then please contact email@example.com for information on obtaining GhostScript binaries from Faximum. You may also obtain a copy of GhostScript from www.sourceforge.net.
Preparing to Install the Faximum Software
NOTE: Customers planning to install the fax software on SCO, SuSE, or UnitedLinux distributions ought to see the special instructions below.
Special Preparations for SuSE eMail Server III
ELS/PLUS/FMS use the X11 font server, when available, to obtain the fonts used to create cover sheets and to convert text to fax format. Unfortunately the SuSE eMail Server III does not ship with any of the scalable fonts needed by the Faximum Software. You can remedy this by installing the xfntscl.rpm package. For the convenience of its customers Faximum has made available a copy of this package on its FTP server. To install this package please run the following command on your SuSE system:
rpm -i ftp://ftp.faximum.com/rpms/xfntscl.rpm
If your SuSE system is not directly connected to the Internet (or if the above command fails to download the needed RPM file), then please FTP the file from our server manually and then transfer it to your SuSE machine and type:
rpm -i xfntscl.rpm
Special Preparations for FMS Installations on the SuSE, SCO, and UnitedLinux Distributions
Also please note that the default configuration of the Postfix email server that is part of the SuSE eMail Server III and UnitedLinux distributions (such as SCO Linux) causes Postfix to tell our software that it is configured to handle fax email addresses even when it is not so configured. This means that when you get to the point of configuring your email server to accept email addresses (assuming you are configuring your FMS server to send faxes) then you will need to take the special steps outlined below.
Please contact Faximum Technical Support should you have any questions or problems with this
Special Notes for FMS Installations
Supported Email/Network Architectures - Outbound Faxing
It is necessary to understand the architecture of your existing email system since FMS integrates fax with your existing email infrastructure. If you have any questions about this then please consult with your network administrator or with Faximum Software.
If you are planning to use FMS to handle incoming faxes only then skip to the section below and Inbound Faxing.
If your network meets the following criteria then you can follow the instructions in this README to install the software:
If your network meets these two criteria then you can proceed to install FMS confident that it will interoperate with your email infrastructure. If these criteria are not meet then please email the details of your email infrastructure to firstname.lastname@example.org and Faximum's engineers will determine if an alternate FMS configuration can meet your needs. For an outline of how to configure FMS to work with networks that have no local SMTP email server (i.e. that use an external email server) see the next section.
If you wish to test a server to see if it is an SMTP server then run telnet to connect to port 25 on the server in question. Under Linux or UNIX (including Mac OS X) you can merely run "telnet 126.96.36.199 25" (without the quotation marks, where 188.8.131.52 is replaced by the IP address or domain name of the server in question) from a terminal session. Using Microsoft Windows, click on the "Start" button, select the "Run" menu option, and type in "telnet 184.108.40.206 25" (again, without quotation marks).
If you are running an SMTP email server on the system in question then
you will see a response of the form "
If your Linux system fails the above test then please see TechNote 236 (http://www.faximum.com/technotes/236).
Once you have verified that the system on which you plan to install FMS is running an SMTP email server then you ought to test that you can send an email to (say) the root account on the machine. If the FMS machine's domain name is (for example) fms.company.com, try sending email to email@example.com and make sure it arrives. If it does not then there may be a problem with (a) your domain name configuration, (b) your email configuration. In either case this problem will need to be resolved prior to installing FMS since if you cannot get email to this server then there will be no way your faxes can be passed to FMS for delivery.
Supported Email/Network Architectures - Inbound Faxing
To see if the Linux server on which you are planning to install FMS is suitable to deliver received faxes, verify that you can send email from this server to users on your network. On your Linux server run the following:
date | mail firstname.lastname@example.org
where email@example.com is the address of one of your users. If they receive an email message that contains the date and time, then your server's email is probably working fine. If not then you will need to work with your network administrator to get the email on your Linux server working otherwise FMS will be unable to deliver the faxes it receives!
How to Configure FMS to Work with External Email Servers
This section outlines how to approach FMS installations in organisations that use an external email server (such as one located at the organisation's ISP). This section is only relevant if you are planning to use FMS to send faxes and you do not use an email server on your local network to deliver email from your users' email clients. If you are going to use FMS to handle incoming faxes only you may ignore this section.
This discussion is, of necessity, relatively technical and intended for email network administrators. If you are not that person then this information ought to be passed to the appropriate person. If you do not have such a person inhouse, then it is necessary to discuss this matter either with Faximum Software or your reseller.
Faximum Software is committed to making your FMS installation a success and will work with you, your reseller, and your ISP to make it all work. Please do not hesitate to email us any questions (technical or otherwise) that arise during the planning of your FMS installation.
Before we proceed to the heart of the matter it will be useful to define some of the terms we will be using:
When installing FMS in an organisation that utilises an external MTA a key task is to determine how to route email so that messages that are to be delivered by fax are passed to the server running FMS for delivery.
If the organisation's Internet connection is always up and it is possible to send email from the Internet to the FMS MTA then there is no problem whatsoever. The default FMS installation and configuration will work just fine.
If this is not the case then one of two alternate approaches must be taken.
If all of the FMS users are located within the organisation (i.e. there is no need to support nomadic FMS users) then the easiest method is to (a) configure the FMS MTA to relay all non-local email to the external MTA; and (b) configure all of the FMS users' email clients to send all their email to the FMS MTA to process or relay to the external MTA.
Another method that will work if the organisation's ISP supports ETRN is to define another domain name for the FMS MTA (i.e. fax.company.com) and have the FMS MTA poll the External MTA for messages to deliver by fax. This requires that the fax domain be properly set up and the FMS MTA set up for ETRN polling.
In summary, configuring FMS to work with an external email server can be done in a number of ways but may present challenges not present when working with an internal email server. We recommend contacting Faximum Software early in your planning so that appropriate preparations can me made for your successful FMS implementation.
The primary security issue related to email-to-fax gateways such as FMS is preventing unauthorised users from sending faxes through your gateway. Since it is possible (depending on the configuration of your server and phone system) to send long distance (indeed overseas) faxes through an FMS gateway, controlling access to an FMS server is important to prevent unauthorised people from incurring toll charges on your phone lines.
FMS itself performs only the most rudimentary of identity checks for incoming email messages that are to be delivered by fax (i.e. it looks at the From header in the email message). Since it is possible to generate messages with fraudulent headers, this mechanism alone cannot be depended upon to prevent unauthorised use. Therefore it is recommended that your network administrator ensure that it is not possible for an email message from an external unauthorised user to be routed to your (internal) FMS server. If you need further assistance in securing your network please contact Faximum Software (firstname.lastname@example.org) for pointers to useful information on this topic.
Installation and Configuration
Installation from the Faximum Web Server
Installation from the Caldera Solutions Showcase CD
Copy the faximum-4.0-25-linux.tar file from the Caldera Solutions Showcase CD-ROM to a temporary directory on your server and continue with the section Running the Installation Script below.
NOTE: The Caldera Solutions Showcase CD installation file contains only the Faximum FMS software. If you need the Faximum ELS or PLUS products you will have to obtain a CD from Faximum Software or download a more recent installation file.
Installation from Faximum CD-ROM
Running the Installation Script
Configuring the Software
Using the Faximum FMS Software
Sending a Fax Without Using the FMS Print Driver for Windows
To send a fax using FMS merely compose an email message (in plain, not HTML, format) using any email client and address the message to:
where the name and fax number in the left-hand side of the address is changed to match your intended recipient and the domain name on the right-hand side is the domain name of your FMS server.
Note that the email address that you send the fax from must be associated with a FMS user account otherwise the request will be rejected as coming from an unauthorised user. For more information go to the Configure -- User Accounts section of the Webadmin interface, select a user, and check that the From email field matches the one you are using to originate the message.
Sending a Fax Using the FMS Print Driver for Windows
If all you need to fax are text messages then the instructions above ought to suffice. If, on the otherhand, you want to be able to fax from your Windows applications (i.e. Microsoft Word) then you will need to use the FMS Print Driver for Windows. You can download the FMS Print Driver from the webadmin interface.
Receiving a Fax Using FMS
If you have enabled the fax line for receiving then you can test this facility by sending a fax to the fax modem and then checking to see if it has arrived by point your browser at http://your.server.name:7437/ (where your.server.name is replaced with the domain name of your FMS server) and select the Route -- Received Faxes link.
Using the Faximum ELS/PLUS Software
Sending a Test Fax Using ELS/PLUS
You can send a simple test fax by first creating a short text file and then using the fxm command. For example:
Receiving a Test Fax Using ELS/PLUS
If you are planning to use Faximum ELS or PLUS to receive faxes you can send a fax to the fax modem and then check the Faximum system log to make sure the fax has been received. For example:
If the fax has been properly received you ought to see something like
03/13/01 17:30:43: faxgetty[3903,0,40857]: listening for calls on fax-line-1 (/dev/tty1A) 03/13/01 17:42:22: faxgetty[3903,0,40857]: fax-line-1: call received 03/13/01 17:42:23: faxcico[3903,0]: incoming fax on device fax-line-1 03/13/01 17:42:40: faxcico[3903,0]: received 1 page from 03/13/01 17:42:48: faxcico[3903,0]: incoming call completed (inbox/cf21) 03/13/01 17:42:48: faxcico[3903,0]: calling "/opt/faximum/lib/dispatch /var/spool/faximum/inbox/cf21" 03/13/01 17:42:48: dispatch[3917,0]: Copy (21): /var/spool/faximum/inbox/newfax-21 03/13/01 17:42:49: dispatch[3917,0]: Mail (21): postmaster 03/13/01 17:42:54: faxgetty[3918,0,40857]: listening for calls on fax-line-1 (/dev/tty1A)
For more information on how to have these faxes automatically printed or passed to your application for processing please see the Faximum ELS & PLUS Reference Manual.
If you are observing errors and the messages in the system log are not sufficient to explain the problem then please execute the following command and email the resulting file /tmp/problem to email@example.com for analysis and assistance.
tar cf /tmp/problem /var/spool/faximum
Starting the ELS/PLUS Fax User Interface
To run the Faximum ELS/PLUS user interface software, type:
To make this easier, you may wish to:
For more information on how to use the Faximum user interface please see the Faximum ELS & PLUS Reference Manual.
Removing the Software
To remove the the server software follow these steps:
Resolving Problems and Contacting Technical Support
Should you experience any problems with this software, please visit our Technical Support web page at: http://www.faximum.com/support. This page provides access to our library of TechNotes that describe solutions to common problems.
Please also visit the page: http://www.faximum.com/status which contains updated information on bugs and fixes available for this release (i.e. your problem may be the result of a bug that has already been reported to Faximum).
If you are still unable to resolve your problem after following those steps, please contact the company that supplied you with this software.
If your vendor is unable to assist, please contact Faximum Technical Support by fax at (604) 926-8182, by email to support@Faximum.COM or by phone at (604) 922-7311.
Please read http://www.faximum.com/support/policy for detailed information on the options available for purchasing technical support.
Note that if you are contacting Faximum Technical Support with a question we need the following information:
It can also help Faximum Technical Support if you also send us a diagnostic snapshot of your installation. You can create this and email it to Faximum by running the following command on your Faximum fax server:
If your fax server is behind a firewall that prevents it from sending email directly to Faximum, then please email the diagnostic output to one of your users who can then forward it to firstname.lastname@example.org. You can do this by running: