Install on Linux

PrizmDoc installation is designed to be very straightforward for Linux environments. Follow the steps provided in this section.

IMPORTANT: PrizmDoc requires a clean installation when migrating from a version earlier than v12.0. You must first uninstall any previous versions of PrizmDoc and reboot your system. Only then should you install PrizmDoc v12.0 or later. Make sure you back up your configuration files before uninstalling any previous versions of PrizmDoc. Once you have installed v12.0, you do not need to uninstall if you want to migrate to v12.1 or later.

NOTE: PrizmDoc relies on a fontconfig package that is not shipped with the product and that might be missing from some distributions of Ubuntu. This was resolved by adding automated checks in the PrizmDoc 13.0 installation scripts. As a workaround for older versions of PrizmDoc, we recommend installing the fontconfig package manually by using sudo apt-get install fontconfig.

Verify the System's Locale
Step 1 - Download PrizmDoc Server
Step 2 - Unpack & Install the Downloaded Archive
Step 3 (Optional) - Including PrizmDoc Services to the Boot Sequence
Step 4 - Configure
Step 5 - Verify that the Installation was Successful
Working with Sample Code
How to Install Common Certificate Authority Root Certificates on Linux

Some steps may be specific to a particular Linux distribution; these steps will be labeled as being specific to one of the following:

"Red Hat / CentOS Linux Distributions"
"Ubuntu Linux Distributions"

Make sure you log in as root to the machine.

Verify the System's Locale

To ensure your system's locale is specified, run the command:

Example
```
 locale
```

If the LC_ALL entry is not set, you must specify it with the following:

Example

 export LC_ALL="en_US.UTF-8"
 sudo localedef -v -c -i en_US -f UTF-8 en_US.UTF-8

Step 1 - Download PrizmDoc Server

IMPORTANT: Before you download PrizmDoc, note that packages are only available for 64-bit systems. Also, you will need to purchase a license key or request a Trial Evaluation by filling out the following form: www.accusoft.com/products/prizm-content-connect-pcc/get-self-hosted/.

Once you have purchased a license key or filled out the form for a Trial Evaluation, you can download PrizmDoc by:

Following the link provided in the response email and selecting the desired Linux Distribution.

OR
Downloading directly to the Linux server using the 'wget' command for the specific distribution as shown below:

NOTES:

You must substitute the version of the package you are using in the code examples below. For example, if you are using v11.0, then specify "11.0" instead of "<version>". If the version is a hot fix, you will also need to specify the hot fix number, for example, "11.0.1".
Instructions assume that one already has 'wget' installed on the server OS.

Red Hat Enterprise Linux, CentOS (prior to v7) and Similar Older Linux Distributions

Example

wget http://products.accusoft.com/PrizmDoc/<version>/prizmdoc_server_<version>.x86_64.rpm.tar.gz

Red Hat Enterprise Linux and CentOS v7 (and later)

Example

wget http://products.accusoft.com/PrizmDoc/<version>/prizmdoc_server_<version>.RHEL7.tar.gz

Ubuntu Linux Distributions

Example

wget http://products.accusoft.com/PrizmDoc/<version>/prizmdoc_server_<version>.amd64.deb.tar.gz

Generic .tar.gz Distribution

Example

wget http://products.accusoft.com/PrizmDoc/<version>/prizmdoc_server_<version>.x86_64.tar.gz

For license questions, fill out the form at http://www.accusoft.com/contact/.

Step 2 - Unpack and Install the Downloaded Archive

Open a command line and change to the location where you downloaded the tarball. Use the following command line examples appropriate for your distribution to:

Decompress and unpack the downloaded file. After you have unpacked the archive, the contents will have been decompressed into a directory named prizmdoc_server_<version>.<arch>[.rpm|.deb].
Change to the unpacked directory and install the packages.

Red Hat, CentOS, and Older Linux Distributions

The following example is for Red Hat, CentOS, and older Linux distributions:

Example

tar -xzvf prizmdoc_server_*.tar.gz
cd prizmdoc_server_*
yum install --nogpgcheck *.rpm

Ubuntu Linux Distributions

The following example is for Ubuntu Linux distributions:

Example

tar -xzvf prizmdoc_server_*.deb.tar.gz
cd prizmdoc_server_*.deb

# Note for Ubuntu 16.04: PrizmDoc requires additional packages to be installed on
# Ubuntu 16.04. Run the following command to install them before installing PrizmDoc.
#
# sudo dpkg -i packages/*.deb
sudo dpkg -i *.deb

# 'dpkg' does not resolve dependencies automatically, so please ignore possible errors, 
# if there are errors about missing dependencies, invoke next command to install dependencies,
# and complete configuration of the packages.
sudo apt-get -f install

Generic .tar.gz Distribution

We also provide a generic .tar.gz package. Please review the System Requirements and Supported Environments topic to ensure compatibility. You will also need to install the dependencies described in the Requirements section. Once the dependencies are installed, you can install the .tar.gz with the following commands as root:

Example

tar -xzvf prizmdoc_server_*.tar.gz
cd prizmdoc_server_*
ls prizm-*.tar.gz | xargs -n1 tar zxf
cp -R prizm /usr/share/

Add symbolic links to the fonts directory and update the system fonts cache to enable the usage of installed fonts by PrizmDoc services.

Example

ln -s /usr/share/prizm/modules/poppler/fonts/accusoft_prizm_fonts.conf /etc/fonts/conf.d/99-accusoft_prizm_fonts.conf
fc-cache -f

Step 3 (Optional) - Including PrizmDoc Services to the Boot Sequence

You can configure PrizmDoc Services to start/stop together with the system in two steps:

Create a symbolic link to /usr/share/prizm/scripts/pccis.sh in the /etc/init.d/ directory:

Example
```
ln -s /usr/share/prizm/scripts/pccis.sh /etc/init.d/pccis
```
Register PrizmDoc Services as an init script, so that it is managed by the system. This step is platform-dependent.

Red Hat, Fedora, CentOS, and Older Linux Distributions

Example
```
chkconfig --add pccis
```
Ubuntu Linux Distributions

Example
```
update-rc.d pccis defaults
```

Once this is done, the system should stop PrizmDoc Services when rebooting or shutting down, and will start again when the server boots up.

Excluding PrizmDoc Services from the Boot Sequence

If you want to prevent PrizmDoc Services from starting/stopping together with the system, you need to revert Step 2 from the section above. This can be performed as follows:

Red Hat, Fedora, CentOS, and Older Linux Distributions

Example

chkconfig --del pccis

Ubuntu Linux Distributions

Example

update-rc.d -f pccis remove

Step 4 - Configure

Continuing as root, change to the installation location: /usr/share/prizm and run setup.sh. This will run the Prizm Licensing Utility (PLU) and configure PrizmDoc for its first run:

NOTE: setup.sh launches the Prizm License Utility (PLU), which is a GUI application. Depending on how you have X11 configured, you might need to run 'xhost +' as the logged in user to allow the PLU launched by the root user to access X11. You can disable X11 access for root by executing 'xhost -' when you are done.

Example

 cd /usr/share/prizm
 sudo ./setup.sh
 Select the type of license you want to acquire:
                 1) Evaluation [e]
                 2) Deployment [d]
             Choose 1 or 2: d
             Select the type of deployment license you have:
                 1) Node Locked [n]
                 2) OEM         [o]
             Choose 1 or 2: o
             Provide the solution name: <MySolutionName>
             Provide the OEM license key provided to you: 2.0...
             Your deployment license was acquired successfully.
             ./scripts/pccis.sh start
             Starting Prizm Content Connect Information Services...
             Starting PCCIS Watchdog process...
             PCCIS Watchdog has been started correctly.

For a production installation, you will want to configure where log files are stored. See the section How to Configure Log File Locations.
If you are licensed to use the Microsoft Office Conversion add-on for PrizmDoc Servers running on Linux, you need to configure your server as described in the topic: Configure Microsoft Office Conversion Connectivity.
Open ports in your firewall according to the Security Guidance.

Step 5 - Verify that the Installation was Successful

Open the PrizmDoc Services Status Page as described in the Checking PrizmDoc Server Health topic and verify the PrizmDoc Services are running.
Your installation is now complete.

Working with Sample Code

Sample code is included to demonstrate how PrizmDoc can be integrated into your Content Management solution. Sample applications using different languages are packaged with the product to demonstrate using a particular language. All of the product samples are located in the "Samples" folder within the installation directory. For more information, refer to the Code Samples topic.

How to Install Common Certificate Authority Root Certificates on Linux

The following commands should all be run as root. Additionally, if prompted for addition/removal permission, then yes/no should be entered as the response.

There are a few options for installing SSL certificates. In all cases, the certificates are stored in /usr/share/.mono/certs/.

Install Mozilla's root CA certificates

You can do this by downloading the certificate data from Mozilla and importing it using mono's mozroots utility, as such:

wget https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt
/usr/share/prizm/mono/64/bin/mozroots --machine --import --ask-remove --file certdata.txt

NOTE: Mozilla may move the certificates to a different URL, as it has done so in the past. Also, mono may error on the first import, requiring you to execute the import command a second time.

Install the CA certificates that are provided by your operating system

Distributions will generally contain CA certificates already, to be used by various tools. They will be stores in a ca-bundle.crt file. You can import those certificates using mono's certmgr utility, as such:

awk 'BEGIN {c=0;} /BEGIN CERT/{c++} { print > "cert." c ".crt"}' < /etc/ssl/certs/ca-bundle.crt
find . -name 'cert.*.crt' -exec sudo /usr/share/prizm/mono/64/bin/certmgr -add -c -m Trust {} \;

NOTE: this will split the bundle file into individual certificate files and import each certificate. It is best to execute this from an empty directory in order to avoid file conflicts. The individual certificates can be deleted after the import.

Install individual certificate files

If you already have a list of custom certificates you need to trust, you can import each certificate file, as such:

/usr/share/prizm/mono/64/bin/certmgr -add -c -m Trust /path/to/certificatefile