Prerequisites

The install procedure below was tested on:

 

Other DEB or RPM based distributions should work as well.

 

Installing

To test if the Ultrascale server is already installed, run:

 

rpm -q XFUltrascale

 

On Debian based distributions, for example Ubuntu, run:

 

dpkg -l xfultrascale

 

To install XF Ultrascale 2011 Server for Linux on RPM based distributions (Redhat, Fedora, Suse) run:

 

rpm -i XFUltrascale-x.x.x-xxxx.i386.rpm

 

On Debian based distributions (including Ubuntu) run:

 

dpkg -i xfultrascale_X.X.X-XXX_i386.deb

 

where x.x.x-xxxx stands for the current version and build number.

 

XF Ultrascale 2011 Server is automatically started and added to runlevels 3 and 5.

The server will listen for rendering requests on port 1099. Incoming connections on this port must be allowed.

A suitable iptables rule for this is:

 

iptables -A INPUT -p tcp --dport 1099 -j ACCEPT

 

What Is Included

The default installation folder is /opt/Ecrion/XFUltrascale.

The following tools and programs are installed under the Bin/ subfolder. Click on the hyperlinks for more information:

 

 

Server Commands

To manually start the XF Ultrascale 2011 Server, run the following command:

 

/etc/init.d/ultrascaled start

 

To stop XF Ultrascale 2011 Server run, run the following command:

 

/etc/init.d/ultrascaled stop

 

On Redhat/Fedora you can also use “service ultrascaled start” and “service ultrascaled stop” to start and stop the daemon.

 

 

Uninstalling

 

To uninstall XF Ultrascale 2011 Server for Linux on RPM based distributions (Redhat, Fedora, Suse) run:

 

rpm -e XFUltrascale2011.rpm

 

On Debian based distributions (including Ubuntu) run:

 

dpkg -r xfultrascale_X.X.X-XXX_i386.deb

 

which will remove everything except configuration files.

 

If you want to remove everything including all configuration files that you may have created run:

 

dpkg --purge xfultrascale

 

 

Testing your installation

 

Rendering a document using JURender:

 

/usr/local/bin/JURender -fo /opt/Ecrion/XFUltrascale/XML\ Samples/XSL-FO\ Test\ Suite/Barcodes.fo -pdf /root/Barcodes.pdf

 

All command line utilities will accept –help to display examples of usage:

 

/usr/local/bin/JURender -help

 

To place the rendered output in the standard output use:

 

/usr/local/bin/JURender -fo /opt/Ecrion/XFUltrascale/XML\ Samples/XSL-FO\ Test\ Suite/Barcodes.fo -pdf stdout -parameters:loglevel=none

 

 

Licences

 

To list installed licenses run:

 

/usr/local/bin/ULicUtil list

 

To install a license:

 

/usr/local/bin/ULicUtil install -key KKKKKKKKKKKKKKKKKKKKKKKKKKKK

 

The program will generate an activation request. Use this activation request to get an activation response in your client area at www.ecrion.com.

 

To activate a license, use the activation response generated in your client area:

 

/usr/local/bin/ULicUtil activate -response XXXXXXXXXXXXXXXXXXXXXXXXX

 

To uninstall a license:

 

/usr/local/bin/ULicUtil uninstall -key KKKKKKKKKKKKKKKKKKKKKKKKKKKK

 

An uninstall request will be printed. Use this uninstall request in your customer area at www.ecrion.com to release the license and use it on another computer.

 

 

Certificate management

 

UCertManager is the certificate management tool used to install / uninstall public certificate / private key pairs (digital identities).

Here is a brief list of commands:

 

 

UCertManager list

 

The command will list all the identities from the container (index in container, issuer and subject).

 

 

UCertManager import pkcs12_file

 

The digital identity information is added to the container.

 

 

UCertManager mport -incert cert_file -inkey privkey_file

 

The digital identity information (the private key and its ownership certificate) is added to the container.

 

 

UCertManager delete -entry index.

 

 

UCertManager export -entry index -out out_file.

 

 

Enabling Logging

 

To configure logging under Linux, edit the UDaemon configuration file located at /opt/Ecrion/Common/UDaemon.config (if the file does not exist, it must be created first).

To enable full logging, write the following lines at the end of the file:

 

LogLevel=Debug
LogFolder=/opt/Ecrion/Common

 
After saving the file, restart the Ultrascale service using the command:

 

/etc/init.d/ultrascaled restart

 

The server will start generating logs in the log folder specified (in this case /opt/Ecrion/Common).

There are several logging levels to choose from, Debug being the most verbose.  Other options are: None(default), Normal, and All.

 

 

Engine Settings

 

To do the engine settings edit the UDaemon configuration file located at /opt/Ecrion/Common/UDaemon.config.

You can find the available settings here.