Getting Started with QuarkXPress Server 2018 - February 2019 Update

Deploying in an external Web container

For development, and simple test deployments, QuarkXPress Server and QuarkXPress Server Manager are provided pre-installed in an instance of Apache Tomcat. However, for production deployment alongside other Web applications, QuarkXPress Server and QuarkXPress Server Manager can be deployed in an existing Tomcat or WebSphere.

Deploying QXP Server in external Tomcat

To install QuarkXPress Server as an independent Web application in an existing Tomcat Web container:

  1. Verify that Tomcat 7.0.77 is installed.

  2. Set up the following environment variables:

    • JAVA_HOME = Java installation folder. For example: E:\Program Files\Java\jdk1.8.0_121

    • CATALINA_HOME = Tomcat installation folder. For example: E:\apache-tomcat-7.0.77

  3. Copy contents of the [QXPS_BUILD]/webapps folder to the [TOMCAT_HOME]/webapps folder.

  4. Copy the [QXPS_BUILD]/conf folder to [TOMCAT_HOME]/bin.

  5. (macOS only) Open the file [Tomcat_Home]/ bin/conf/ServerApp.properties and make the following changes:

    • Uncomment the Mac OS X settings section:

      #qxpserver.serverRendererPath=./webapps/ROOT/QuarkXPressServer
      Renderer/QuarkXPress Server.app/Contents/MacOS
      #qxpserver.serverRendererExecutableName=QuarkXPress Server
      #qxpserver.DocumentRootFolder=/QuarkXPress Server Documents
    • Comment out the Windows settings section:

      qxpserver.serverRendererExecutableName=QuarkXPress Server Renderer.exe
      qxpserver.DocumentRootFolder=C\:\\QuarkXPress Server Documents
  6. In the [TOMCAT_HOME]/bin/conf/Qla.properties file, set the host name, port number, and serial number of your instance of QLA Server.

    • Enter the IP address or hostname of the QLA Server in the QlaServer.machinename= field.

    • Enter the port number of the QLA Server in the QlaServer.port= field. If you have a backup QLA server, enter the IP address (or hostname) and port number in the Backup.QlaServer.machinename= and Backup.QlaServer.port= fields.

  7. (Windows only) Execute vcredist_x64.exe provided with the build before starting QXPS.

  8. Copy the Documents folder to [TOMCAT_HOME].

  9. Open [TOMCAT_HOME]/conf/server.xml and add the following inside the <Host name="localhost" appBase="webapps".....> tag:

    <Context path="/qxps/documents" docBase="../Documents/Documentation" >
    <Manager pathname=""/>
    </Context>Uncomment the Mac OS X settings section.

Deploying QXPSM in external Tomcat

To install QuarkXPress Server Manager as an independent Web application in an existing Tomcat Web container:

  1. Verify that Tomcat 7.0.77 is installed.

  2. Locate the Tomcat installation folder (referred to here as [Tomcat_Home]).

  3. Locate the QuarkXPress Server Manager external Tomcat installation folder (referred to here as [QXPSM_Tomcat]).

  4. Drag the contents of [QXPSM_Tomcat]/conf to [Tomcat_Home]/conf.

  5. Drag the contents of [QXPSM_Tomcat]/webapps to [Tomcat_Home]/webapps.

  6. Drag [QXPSM_Tomcat]/qxpsm to [Tomcat_Home].

  7. Open the file [Tomcat_Home]/conf/ManagerContainerConfig.xml and make the following changes in the ContainerAdapter bean:

    • Set cacheFolderContextFile to the path of the "cache.xml" file relative to the current working directory.

    • Set serverXmlFilePath to the path of the "Server.xml" file relative to the current working directory.

  8. Open the file [Tomcat_Home]/conf/Catalina.properties and specify the path of the shared class loader. For example:  shared.loader=${catalina.home}/qxpsm/lib/*.jar,${catalina.home}/conf

  9. Open the file [Tomcat_Home]/conf/Catalina/localhost/cache.xml and set the docbase attribute to the path of the appropriate cache folder.

  10. Double-click the "startup.sh" shell file (macOS) or the "startup.bat" file (Windows). These files can be found in the TOMCAT_HOME/bin folder.

Deploying QXP Server in WebSphere

To install QuarkXPress Server as an independent Web application in an IBM WebSphere Web container:

Prerequisites

  1. Download the IBM Installation Manager 1.6.2 software and extract its contents to your local folder (for example, IBM_MANAGER_DIR).

  2. Download the IBM WebSphere 9.0.0.3 developer version software. This is in 3 parts in an archived (.zip) format.

  3. Extract all 3 parts of IBM WebSphere 9.0.0.3 to your local folder (for example, IBM_WEBSPHERE_DIR).

  4. Download the SDK for Java 1.8 for IBM WebSphere 9.0.0.3, This is in 3 parts in an archived (.zip) format.

  5. Extract all 3 parts of SDK for Java 1.8 to your local folder (for example, SDK-FOR-Java-1.8_DIR).

Installing the IBM-WebSphere developer version

  1. Go to the $(IBM_MANAGER_DIR) folder and run "install.exe" with administrator privilege.

  2. Launch the IBM Installation Manager 1.6.2 with administrator privilege.

  3. Go to File->Preferences. The Preferences dialog displays. Select the Repositories option on the left side.

  4. Click the Add Repository button from the right side. Browse to and select the "respository.config" file from the $(IBM_WEBSPHERE_DIR)/was.repo.9003.developers.ilan_part1 folder.

  5. Click Apply and then click OK.

  6. Go to the IBM Installation Manager, select the Install option.

    IBM WebSphere 9.0.0.3 will be installed in your Program Files location. C:\Program Files (x86)\IBM\WebSphere.

  7. During the installation, you will be asked to enter the configuration file for Part 2 and Part 3 of IBM WebSphere. Select the files from their respective folders:

    • $(IBM_WEBSPHERE_DIR)/was.repo.9003.developers.ilan_part2

    • $(IBM_WEBSPHERE_DIR)/was.repo.9003.developers.ilan_part3

  8. Go to Start->WebSphere Customization Toolbox. Select the Create option on the right side.

    The Profile Management Tool dialog displays.

  9. Select Application Server as the WebSphere Application Server and click Next.

  10. Select Typical file creation and click Next.

  11. Select Disable Administrative Security and click Next.

  12. Select Create a profile.

Configure the Java 7 SDK in the IBM WebSphere

  1. Open the cmd window. Navigate to the $(WS_INSTALLED_DIR)/AppServer/bin folder.

  2. Type the command managesdk.bat -listAvailable.

  3. Launch the IBM installation manager.

  4. Go to File->Preferences. The Preferences dialog displays. Select the Repositories option on the left side.

  5. Click the Add Repository button from the right side. Browse to and select the "repository.config" file from the $(SDK-FOR-Java-1.8_DIR)/was.repo.9003.java7_part1 folder.

  6. Click Apply and then click OK.

  7. Go to the IBM Installation Manager, select the Install option.

    IBM WebSphere 9.0.0.3 will be installed in your Program Files location. C:\Program Files (x86)\IBM\WebSphere.

  8. During the installation, you will be asked to enter the configuration file for Part 2 and Part 3 of IBM WebSphere. Select the files from their respective folders:

    • $(SDK-FOR-Java-1.8_DIR)/was.repo.9003.java7_part2

    • $(SDK-FOR-Java-1.8_DIR)/was.repo.9003.java7_part3

  9. The Java7 SDK for IBM WebSphere will be installed successfully. Check it at  the $(WS_INSTALLED_DIR)/AppServer/java_1.8_64 folder

  10. Open the cmd window. Navigate to the $(WS_INSTALLED_DIR)/AppServer/bin folder.

  11. Type the command managesdk.bat -listAvailable.

  12. Type the command managesdk.bat -enableProfile -profileName AppSrv01-sdkname 1.8_64. This binds IBM WebSphere into Java7 runtime.

Start IBM WebSphere

  1. Enter First Step.bat from the start menu or from  $(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01/firststeps/firststeps.bat.

    The WebSphere Application server dialog displays.

  2. Start the Server.

QXPS WebApp deployment into IBM WebSphere UI

  1. Copy the [QXPS_BUILD]/conf folder to WebSphere's current directory (for example,  $(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01. Open "ServerApp.properties" and update the following:

    • qxpswebserver.embeddedwebcontainer= false

    • qxps.webapp.context.name= /qxps

  2. Open the "QXPSLoadComponents.properties" file located at $(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01/conf and remove the following entries:

    <import resource="classpath:com/quark/azure/auth/AzureAuthContext.xml"/>
    <import resource="classpath:com/quark/qxps/azure/config/AzureConfiguration.xml"/>
    <import resource="classpath:com/quark/qxps/azure/config/AzureConfiguration.xml"/>
  3. Open the "PropertiesFilePlaceholders.properties" files located at $(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01/conf and remove the following entries:

    • <value>file:./conf/AzureAuthenticate.properties</value>

  4. In the [TOMCAT_HOME]/bin/conf/Qla.properties file, set the host name, port number, and serial number of your instance of QLA Server.

    • Set QlaServer.machinename to the IP address or hostname of the QLA server.

    • Set QlaServer.port to the port number of the QLA server.

    • If you have a backup QLA server, set Backup.QlaServer.machinename and Backup.QlaServer.port to its IP address or hostname and port number.

  5. Extract the "EAR (qxps-2018.ear)" file. Open the "qxps-servlet.xml" file located at $(QXPS-EAR_DIR)\qxps-2018\source\qxps\WEB-INF\ and remove the following entries:

    <value>file:./conf/AzureAuthenticate.properties</value>
    <property name="authManager" ref="azureAuthenticationManager"/>
    <prop key="/secure/azureauth">azureAuthReplyController</prop>
    <property name="authResultCBHandler" ref="qxpsAzureAuthResultCBHandler"/>
    <property name="authManager" ref="azureAuthenticationManager"/>
  6. Create the WAR bundle by using the  "CreateQXPS_EAR.bat" batch file located at the extracted folder: $(QXPS-EAR_DIR)

  7. Open http://localhost:9080/ibm/console/ in a browser and login.

  8. Select the Application tab from the right and select New Application.

  9. Select New Enterprise Application. When asked for the path to the new application, choose the file and click Next.

  10. When asked “How do you want to install the application?”, select Fast Path and click Next.

  11. Change the application name if required and click Next.

  12. Select both the modules and click Next.

  13. Select both the web modules and click Next.

  14. Select the qxpsadmin module and click Next and then Finish.

  15. Save the changes to the master configuration.

  16. Select the Server tab from the right and select WebSphere Application Servers> server1 > Web server plug-in properties.

  17. Set the maximum number of connections that can be handled by the application server to 150.

  18. Save the changes.

  19. Select the Application tab from the right and select Application Types -> WebSphere Enterprise applications. Select qxps and Start.