PrizmDoc® Viewer v14.0 Release - Updated
PrizmDoc Viewer / Administrator Guide / PrizmDoc Server / Installing / Migrate to Docker
In This Topic
    Migrate to Docker
    In This Topic

    With the PrizmDoc Viewer v13.25 release, the traditional Linux PrizmDoc Viewer install packages for the following platforms are no longer available:

    • CentOS 7
    • Red Hat Enterprise Linux 7
    • Ubuntu 18.04 LTS

    To ensure a seamless and secure transition, we recommend the following approaches:

    For customers who are still using our traditional Linux packages and not looking to immediately upgrade those platforms, we recommend switching to the PrizmDoc Docker-based distributive package while continuing to use your existing Linux platforms. This approach will allow you to take advantage of the benefits of the newer product version without the need for an immediate platform upgrade.

    Alternatively, you may consider upgrading your Linux platforms to newer ones while continuing to use the PrizmDoc Docker-based distributive package. This will not only provide you with the advantages of the updated product version but also ensure compatibility with the latest Linux environments.

    We understand that migration may raise questions or concerns. Therefore, we’re providing the following transition guide from Traditional Linux Install Packages to a Docker-based distributive package.


    • You may have a deprecated node-locked license which will not work in Docker. You will need to contact your Accusoft Account Manager for licensing concerns.
    • You will want to make sure that your version of Linux is compatible with Docker. You can check this Docker documentation page under "Supported platforms" to verify compatibility.

    Steps to Migrate to Docker:

    What You’ll Need - Tools/Downloads

    • Root access on the host server.

    • Install Docker (instructions in the link).

      • Confirm installation with hello-world container with this command:

        docker run --rm hello-world
      • This container will output text to the console confirming that your installation was successful and then exit and remove the container.

    • Next, we will "pull" the containers. We recommend that you leave the version tag off as this will pull the latest versions. These will take less than a couple GB of space in the Docker directory:

        docker pull accusoft/prizmdoc-server:{version_tag}
        docker pull accusoft/prizmdoc-application-services:{version_tag}

    Prep - Backups

    • Create required folders using this command:

        sudo mkdir /prizmdoc && cd /prizmdoc && sudo mkdir config data logs
    • Create copies of the PrizmDoc config files listed below and place them in the newly created config folder. See the links for where these files are located.

    • If these are in the default location then the following will copy the files. Omit the last line if pas is not present.

    sudo cp /usr/share/prizm/prizm-services-config.yml /prizmdoc/config/
    sudo cp /usr/share/prizm/pccis/ServiceHost/pcc.config /prizmdoc/config/
    sudo cp /usr/share/prizm/pas/pcc.nix.yml /prizmdoc/config/

    IMPORTANT: If you run both PAS and Server containers on the same host, keeping the default pccServer.hostName value of localhost will not work. You can use the host machine's IP address. Alternatively, you can put both PAS and Server on a dedicated bridge network and reference prizmdoc-server container by its name.

    Migration - Installs/Build Container

    1. Stop old PrizmDoc Server and PAS services:

       /usr/share/prizm/scripts/ stop
       /usr/share/prizm/pas/pm2/ stop
    2. Switch to the prizmdoc folder we created earlier:

       cd /prizmdoc
    3. Run the commands below which will start the PrizmDoc Server and PAS containers:

       docker run -d --restart=unless-stopped --env ACCEPT_EULA=YES --publish 18681:18681 --volume $(pwd)/config:/config --volume $(pwd)/logs:/logs --volume $(pwd)/data:/data --volume $(pwd)/config/pcc.config:/usr/share/prizm/pccis/ServiceHost/pcc.config --name prizmdoc-server accusoft/prizmdoc-server
       docker run -d --restart=unless-stopped --env ACCEPT_EULA=YES --publish 3000:3000 --volume $(pwd)/config:/config --volume $(pwd)/logs:/logs --volume $(pwd)/data:/data --name pas accusoft/prizmdoc-application-services
    4. Check the health and connection endpoints for the containers. A 200 OK response indicates that the containers are healthy and able to talk to one another. If you receive a 200 OK from each of the following endpoints, proceed to the Testing Application Functionality section below.

       curl -i http://localhost:18681/PCCIS/V1/Service/Current/Health
       curl -i http://localhost:3000/health
       curl -i http://localhost:3000/servicesConnection
      • http://localhost:18681/admin
      • http://localhost:3000/health
      • http://localhost:3000/servicesConnection
    1. If the endpoints above do not each return a 200 OK, do the following to revert to your original installation:

      1. Stop the PrizmDoc containers:

         docker stop prizmdoc-server pas
      2. Restart the old PrizmDoc Server and PAS services:

         /usr/share/prizm/scripts/ start
         /usr/share/prizm/pas/pm2/ start
      3. Create a support ticket for assistance.

    Test Application Functionality

    1. Test your application to make sure it is working by performing some all important operations, such as viewing a document or starting a document processing workflow.

    2. If the application is not working as expected, you can stop the container using the following command:

    docker stop prizmdoc-server pas
    1. You'll want to restart the services to your local install to get back up and running:
    /usr/share/prizm/scripts/ start
    /usr/share/prizm/pas/pm2/ start
    1. Create a support ticket for assistance.

    Cleanup - Uninstall the Native Linux Service

    1. Make sure you log in as root to the machine.
    2. Stop the service:

      NOTE: This will depend on where the product is installed. The command for default installations will look like the following:

       /usr/share/prizm/scripts/ stop
    3. Remove the installed files:

      • Ubuntu:

          apt-get purge prizm-services.*

        IMPORTANT: Running this command will remove all configuration files. If you would like to keep the configuration files you can instead run apt-get remove prizm-services.* However, leaving behind configuration files may cause issues in the future. You may want to create a backup of the configuration files before purging as an alternative.

      • Red Hat/CentOS:

          yum remove prizm-services*

        IMPORTANT: This will not properly execute if run in a directory with files matching the wildcard, for example, the /usr/share/prizm/ directory or the directory where the downloaded Prizm services .deb or .rpm files are located.

      • Generic Package:

          rm /etc/fonts/conf.d/99-accusoft_prizm_fonts.conf
          fc-cache -f
          rm -rf /usr/share/prizm/bin
          rm -rf /usr/share/prizm/conf
          rm -rf /usr/share/prizm/consul
          rm -rf /usr/share/prizm/java
          rm -rf /usr/share/prizm/libreoffice
          rm -rf /usr/share/prizm/libs
          rm -rf /usr/share/prizm/modules
          rm -rf /usr/share/prizm/mono
          rm -rf /usr/share/prizm/node.js
          rm -rf /usr/share/prizm/pccis
          rm -rf /usr/share/prizm/plu
          rm -rf /usr/share/prizm/schemas
          rm -rf /usr/share/prizm/scripts
          rm -rf /usr/share/prizm/services
          rm -rf /usr/share/prizm/src

        After completing removal of the native Linux service, the migration to Docker is complete.