esup-cupsbackend - Install and upgrade

Owned by Pascal AUBRY
Last updated: Dec 03, 2007Version comment

This pages shows how to install and upgrade the esup-cupsbackend application on your CUPS server. 

Requirements

  • JDK 1.5+
  • Apache ant 1.7+
  • CUPS 1.3.2+ (see CUPS patch)
  • Samba 3.0.24+

/etc/profile.d/java.sh:

export JAVA_HOME=/opt/jdk1.5.0
export ANT_HOME=/opt/ant
export PATH=$PATH:$JAVA_HOME/bin:$ANT_HOME/bin

First install

Download

Download the latest version of the package esup-cupsbackend from http://sourcesup.cru.fr/frs/?group_id=319

Uncompress

Unzip the distribution files somewhere in your source hierarchy (something like /usr/local/src/esup-backend).

This will create a foder like /usr/local/src/esup-cupsbackend/esup-cupsbackend-x.y.z.

Configure

Edit the following configuration files to fit to your environment (examples are provided):

  • /build.properties: tell the application where and how to install.
  • /properties/config.properties: configure the application runtime.
  • /properties/logging/log4j.properties: configure the logs of the backend.
  • /properties/logging/log4j-batch.properties: configure the logs of the batch commands.

  The folder tmpDir set in /properties/config.properties should be writable by the CUPS user (usually lp) as it used by esup-cupsbackend to store the states of the queues. The folder that contains the logs (see /properties/logging/log4j.properties) should also be writable by the CUPS user (the folder and not just the file, to allow log4j rotations).

Deploy

Simply run:

ant deploy

Use

When modifying a printer through the CUPS web interface, CUPS should now show a new backend named ESUP-Portail.

URIS of printers with the ESUP-Portail backend look like:

esup://<printer_ip_or_fqdn>?model=<model>[&options]

Available models are hp, lexmark, xerox, toshiba, dell, jetdirectNoAccounting, jetdirectGenericSnmpAccounting, jetdirectGenericSnmpAccountingPjlInfo (have a look at /properties/domain/domain.xml to add your own models).

Options :

  • socketPort=<socket_port> (jetdirect printers only)
  • lpdPort=<lpd_port> (LPD printers only)
  • lpdPath=<lpd_path> (LPD printers only)
  • ippPort=<ipp_port> (IPP printers only)
  • ippPath=<ipp_path> (IPP printers only)
  • pjlPort=<pjl_port> (PJL printers only)

Upgrades

Download the latest version of your package and install beside your previous installation at the same filesystem level (/usr/local/src/esup-cupsbackend in our example).

unzip the package.

go to the newly created directory.

Recover your previous configuration files by running:

ant recover-config

Deploy:

ant deploy