Page 1 of 4
Installing MiramoPDF
Introduction..................................... 1
Installing MiramoPDF on Windows... 1
Installing MiramoPDF on Linux ......... 3
Testing the installation..................... 4
February 2, 2021
Datazone Ltd, Kenmare, Kerry,
Ireland Tel: +353 64 66 289 64.
www.miramo.com Email:
miramo@datazone.com
Introduction
This document describes how to install and configure version 2.0.0 of the MiramoPDF
composition engine and GUI template designer on Windows, Linux and MacOSX.
This description assumes you have downloaded the platform specific installation packages
as follows:
MiramoPDF installation packages
Windows:
MiramoPDF-2.0.0pNNNsetup.exe
MacOSX (Catalina):
MiramoPDF-OSX-2.0.0pNNN.pkg
Linux RH (CentOS 7, Amazon Linux 2, Oracle Linux R7-U7):
MiramoPDF-RH-2.0.0pNNN.tar.gz
(Does not include MiramoDesigner)
Linux RHD (Fedora 33)
MiramoPDF-RHD-2.0.0pNNN.tar.gz
Linux DB (Debian, Ubuntu 20)
MiramoPDF-DBD-2.0.0pNNN.tar.gz
The platforms and versions given above have been subject to internal testing, the list is not
comprehensive - other versions may work.
Installing MiramoPDF on Windows
Double-click on the MiramoPDF-2.0.0pNNNsetup.exe to install MiramoPDF. When
prompted, navigate to your chosen installation folder (default is C:\Program
Files\Miramo\MiramoPDF 2.0.0) and click on ’OK’ to continue.
If an earlier version of MiramoPDF is already installed, you will be prompted as shown
below:
 DITA-OT plugin Page 2 of 4

Installing MiramoPDF

Click on ’Yes’ to uninstall the previous version (recommended), or click on ’No’ to proceed without
uninstalling the previous version.
Choosing default options will create the following folder:
C:\Program Files\Miramo\MiramoPDF 2.0.0
The MiramoDesigner 2.0.0 desktop shortcut will be updated to point to MiramoDesigner.exe in this
folder, and the miramo.exe binary (composition engine) is located in the same folder.
The PATH environment variable will be set as shown below. Note that if you chose not to uninstall the
previous version, both the earlier version and 2.0.0 install folders are included in the PATH environment
variable, but the earlier version (1.6 in the example below) takes precedence.
 DITA-OT plugin Page 3 of 4

Installing MiramoPDF
It is recommended to keep this as-is, so that existing publications work with no additional changes.

Installing MiramoPDF on Linux

Log in to the target server as an admin user and follow the steps below:

1. Create a new folder if necessary, eg /opt/miramo:

sudo mkdir -p /opt/miramo
2. Change directory to the new folder:
cd /opt/miramo
3. Extract files from the downloaded distribution package, for example:
sudo tar -xzof /tmp/MiramoPDF-DBD-2.0.0pNNN.tar.gz
to create /opt/miramo/MiramoPDF-2.0.0pNNN - this is the Miramo installation folder.
4. Change directory to the installation folder, eg:
cd /opt/miramo/MiramoPDF-2.0.0pNNN
5. Run the install.sh script:
sudo ./install.sh
The install.sh script runs the ’installComposer.sh’ script which installs the fontconfig prerequisite if
necessary. It also makes a link from /usr/local/bin/miramo to the runComposer.sh wrapper script located
in the installation folder, so the miramo command (composition engine) is automatically available to all
users.
For Linux RHD and DBD distributions, the install.sh script also installs MiramoDesigner using the
’installDesigner.sh’ script.
If you wish to install multiple concurrent versions of the composition engine, and are publishing using the
MiramoPDF DITA-OT plugin, the location of the runMmComposer.sh script may be configured using the
’miramopath’ ant build parameter.

Installing MiramoPDF on MacOSX

Installing MiramoPDF on MacOS

1. Locate the downloaded .pkg and right-click to 'Open',

or double click on the .pkg from your browser:
 DITA-OT plugin Page 4 of 4

Installing MiramoPDF
2. The beta version package is not notarized, so the following notifications will show, dismiss them both:

3. To address this click the apple icon, click system preferences and choose 'security & privacy' - click on
'Open Anyway':

This will open the MiramoPDF installer which can be followed with default options selected.

Testing the installation

Create a file ’test.xml’ in a temporary folder, containing the following MiramoXML markup:
<MiramoXML>
<P>Hello World!</P>
</MiramoXML>
Start a command window, change to the folder containing the ’test.xml’ file and enter the following
command:
miramo -Opdf test.pdf test.xml
If successful the following message will be displayed:
mmComposer: 1 : Completed 0 error(s) and 0 warning(s)
... and the ’test.pdf’ file will be creating containing ’Hello World!’