hmediade/printserver repository overview

⁠PrintServer

A REST API that connects into an Avid™ Newsroom Management system and generates PDF renderings of any data. It is the server component for the Hmedia PrintClient.

⁠Getting Started

The container runs as a service. It connects into one or multiple Avid iNEWS systems to read rundowns and stories. It takes incoming RESTful requests, process them and sends generated PDF documents back to the PrintClient.

It is based on the Tomcat image tomcat:9.0.85-jre17-temurin-jammy, and provides its services on port 8080.

The PrintServer container doesn't need injected environment variables. It has an entirely filebased configuration.

⁠Prerequisities

In order to run this container you'll need docker installed.

• Windows⁠
• OS X⁠
• Linux⁠

⁠Usage

⁠Container Parameters

To run the container fully functional:

docker run -p [your desired port]:8080
           --mount type=bind,source=[source path to config directory],target=/data \
           --mount type=bind,source=[source path to printstyles directory],target=/stylesheets \
           hmediade/printserver:latest

The PrintServer functionality is then available under http://[docker host]:[your desired port]/printserver.

To inspect the container:

docker run -d --name printserver-test <parameters> hmediade/printserver:latest
docker exec -it printserver-test bash
docker kill printserver-test
docker remove printserver-test

⁠Environment Variables

No environment variables required.

⁠Volumes

• /data - This path need to have two files injected:

  • inewsconf.xml - it configures the PrintServer connection into Avid's™ Newsroom Management system. The syntax and a description can be found in the PrintManager documentation, available on the Product Page⁠.
  • license.lic - the product license file provided from Hmedia when you purchase the PrintManager. Trial licenses are available. Contact us via [email protected]⁠.

• /stylesheets - This directory is the place for the printstyles - XSLT stylesheet files that specify the conversion of iNEWS data into a certain PDF rendering. Any number of printstyles and subsequent directories/files like icons and graphics iis supported. The directory must also contain the file iNewsSystems.txt which assigns the various printstyles to particular iNEWS systems and directories/queues. Please refer to the PrintManager documentation, available on the Product Page⁠, for further details.

⁠Useful File Locations

• /usr/local/tomcat/webapps - Location of the Hmedia PrintServer application

• /usr/local/tomcat/shared/classes/printserver - The PrintServer Home directory. When the container runs, all printserver-related files have to exist here - via link or copy.

• /usr/local/tomcat/start.sh - The start script of the container. It copies config files to their right location and starts the Apache Tomcat.

⁠Built With

• Based on tomcat:9.0.85-jre17-temurin-jammy
• Built and tested with Microsoft Docker Desktop, Engine v24.0.7

⁠Find Us

• Web⁠
• Docker Hub⁠

⁠Versioning

Version 4.0.0 App version fixed to be compliant with SemVer. Version 3.3.0 broke backward compatibility to clients <= 3.2.0 with fixed MIME settings for the REST API. So, to indicate that break, version was increased to 4.0

Version 3.3.0 Initial release of the PrintServer as containerized app.

We use SemVer⁠ for versioning. For the versions available, see the tags on this repository⁠.

⁠Authors

• Sebastian Lorenz - PrintServer Development - [email protected]⁠
• Andreas Hartmann - PrintServer Development, Docker Image Creation - H media⁠, [email protected]⁠