Table of contents
Installation Guide for SUSE
smart upgrade ghostscript-library ghostscript-fonts-std ghostscript-fonts-other TODO: add the other package update commands.
For non SUSE systems first try using the standard package installer.
Depending on the version of OpenOffice you may need to install Xvfb.
If you just install the Open Office writer (rather than the whole Open Office package) then as of Open Office 3.x Xvfb should no longer be needed.
Xvfb provides a virtual video device for systems which do not have X installed. If you already have X installed (which it will be if you are using a desktop version of Linux then you don't need Xvfb).
X frame buffer is required by some versions of openoffice.org to run in headless mode (e.g. on server with no gui) Open Office is used to convert MS Office and openoffice.org documents to PDF which is then converted by ghostscript to a tiff file.
Note: as of Noojee Fax 3.0 the trial & commercial edition now does a self install and the following five (5) steps are done as part of the install. If you are using the Open Source Edition then you need to perform the following steps yourself.
For the open source edition you will need to do the following for yourself.
1. Create deployment directory - usually /usr/lib/noojeefax
2. Unzip the NoojeeFax file to the deployment directory
3. Create the spool directories## mkdir -p /var/spool/noojeefax/spool
mkdir /var/spool/noojeefax/fax mkdir /var/spool/noojeefax/tmp mkdir /var/spool/noojeefax/incoming
4. Create the log directory
5. copy the appropriate init script into /etc/init.d
You should find an 'init' directory in the expanded archive which contains an init file for a number of different distributions. Copy the appropriate one for you distribution into the /etc/init directory.
Edit the file and replace all occurrences of @@INSTALLDIR@@ with /usr/lib/noojeefax
Rename the file to noojeefax and check it has the correct permissions.
e.g. for redhat
cd /usr/lib/noojeefax/init sed -e "s#@@INSTALLDIR@@#/usr/lib/noojeefax#g" -i redhat_init cp redhat_init /etc/init.d/noojeefax chmod a+x /etc/init.d/noojeefax
Digium Fax for Asterisk
As of Noojee Fax 3.0, the trial & commercial edition ships with the Digium Fax for Asterisk drivers.
The Digium Fax drivers provides the most reliable method of transmitting faxes under Asterisk.
Tests with Spandsp and IAXModem (which uses IAXModem) show that both perform badly on high density faxes (lots of black) and multi-page faxes. Having said that, Spandsp is free
Note: As of March 2010 the latest build of spandsp was crashing Asterisk.
If you are looking for a fax solution for your own purposes and don't mind have to resend some faxes then Spandsp is probably fine. If you are looking at selling a customer a fax solution as part of an Asterisk install then using Spandsp is a very bad idea (we found this out the hard way ;< ).
Software Fax Modem installation
Two software fax modems are available.
- Digium's Fax for Asterisk (recommended)
- Spand DSP
The trial and commercial editions automatically install the Digium Fax for Asterisk software so no further action is required.
Note: You MUST have either Digium's Fax for Asterisk or SpanDSP installed. You MUST NOT HAVE BOTH INSTALLED!
Spandsp - open source version
Refer to the following page for Spandsp installation:
Configuring Noojee Fax
Once Noojee Fax has been installed you need to config it for your specific requirements.
For the commercial and trial version the installer will have done most of the following for you.
For the Open Source edition you will need to hand configure most of the following.
NoojeeFax config file are located in the NoojeeFax config directory. The primary config file is NoojeeFax.xml. The following are the most significant configuration items:
1. The Asterisk channel that is to be used for dialling out. Search the file for <Channel>. Enter the channel name in the <Name> element, .e.g <Name>DAHDI/g0</Name> or <Name>DHADI/1</Name>.
2. If you are using a channel name such as DAHDI/g0 which can support multiple channels then number of channels that you want to use in the <Count> element. If you are using a single channel such as DAHDI/1 then you need to add a <Channel> element for each channel (e.g. DAHDI/1, DAHDI/2).
3. The inbound SMTP configuration for processing emails. The system is configured to listen on a port on any interface on the machine. Usually there will be an SMTP server running on the host. In this case the NoojeeFax SMTP server must be configured to listen on an alternative interface or the port has to be changed. Changing the port is not recommended. Other inbound mail mechanism are available and can be discussed if need be.
1. Search for <InBoundMail> in the file.
2. Enter the interface address in <Host>
3. Enter the port number in <Port> (usually 25)
4. The outbound SMTP configuration is required to send receipts and notices to users.
1. Search for <OutBoundMail>
2. Set the from address using the answer to Q7 of the questionnaire in <From>
3. Set the Host, Port, Username and Password using the answer to Q8 in the questionnaire in the corresponding elements
5. Asterisk manager connection details must be provided so NoojeeFax can originate calls and receive events.
1. Setup a suitable account with all permissions in Asterisk manager.conf
2. Search for <Asterisk>
3. Enter the Manager API Host, Username and Password in the corresponding elements.
6. The mechanism used to submit faxes can vary between installs. The commercial version sets the correct default submitter for the Digium Fax for Asterisk drivers.
1. Search for <Submitter>
2. -Enter the mechanism name in <Name>. For spandsp au.com.noojee.noojeefax.outbound.submitter.DefaultSubmitter is required. That is the default value.-
3. No arguments are required for the default submitter.
4. To use PikaFax change the submitter to: au.com.noojee.noojeefax.outbound.submitter.PikaFaxSubmitter
7. The mechanism used to receive faxes can vary.
1. Search for <Receiver>
2. Enter the name in <Name>. The default is almost always sufficient.
3. No argument are required for the default.
8. The company name and return fax number can be set as well as the format of the header and footer on each page.
1. Enter the company name as specified in answer to Q1 of the questionnaire in <CompanyName>
2. Enter the return fax number given in asnwer to Q2 in <ReturnFaxNumber>
3. Enter fax header formatting details in <FaxHeader>. If a specific font is required set that in <Font>.
4. In the <Text> element enter any text that is required to appear left aligned, centered or right aligned in the corresponding elements (<Left>, <Centre> or <Right>). Some special replacable charaters are recognised:
1. %C - the company name as entered in <CompanyName>
2. %R - the return fax number as entered in <ReturnFaxNumber>
3. %D - the date
4. %T - the time
5. %P - page/page count (e.g. 2/3)
6. %S - the subject from the email
5. Set the footer in the <FaxFooter> element.
6. Templates allow for company name, return fax number, header and footer variation depending on the fax number provided.
7. <PageSize> is usually set to a4. Also acceptable is letter.
8. Ensure that <Outbox>, <SpoolFolder> and <TempFolder> all agree with the spool folders created when installing NoojeeFax.
9. For incoming faxes NoojeeFax by default will send the incoming fax to a static list of recipients configured into <Asterisk><RxFax><Handlers> where the <Name> is au.com.noojee.noojeefax.handler.DefaultFaxHandler. To configure the static list of recipients enter a comma separated list of email addresses into the <Arguments> element for the DefaultFaxHandler.
10. Where inbound fax routing is required the configuration changes. Enter au.com.noojee.noojeefax.hander.XmlRoutingHandler in <Name> and edit the config/FaxRoutes.xml.
Ideally you should have answers to the following questions before you start the install
Please provide answers for the following questions. These will be used to configure NoojeeFax correctly after it has been installed on your system.
1. What company name is to appear in the fax header or footer?
2. What is the return fax number?
3. What is the required format for the header and footer? We can include the company name, date, time, e-mail subject, page numbers and return fax number.
4. What is the required page size, a4 or letter?
5. NoojeeFax operates as a simple SMTP server as such it needs a DNS entry on your network. The best practice is to create an internal domain 'fax.local' on your internal DNS server and include an MX record which points a the Noojee Fax server. Staff will then be able to send faxes from their standard email client (outlook, thunderbird etc) without requiring any special configuration. The built in SMTP server is not designed to be secure and does not have any relay protection or filtering functionality.
1. Must delivery receipts be mailed with a TIFF or PDF attachment or with an embedded JPEG of the fax?
2. What mail address is to be used for mail sent from the NoojeeFax server?
3. What is the host address, port, user and password for an SMTP server to be used for outgoing mail?
4. What kind of inbound fax routing is required? Do you need faxes to be routed to individuals based on DID or must all faxes be routed to one individual or a group of individuals?
5. What channels are to be used for outbound faxing?
6. Are any DID's being dedicated to inbound faxing?
Please see the FAQ for dialplan.
Finally if you are using the Noojee Fax commercial edition (or trail) you will want to configure the mappings between the inbound DID and each email address. Refer to this article: