Download and Installation

Download and Installation

Menu

Prerequisites

Java

The server and the desktop application require a Java runtime environment. Windows and Mac users do not have to worry about Java because it is included in the DAISY Pipeline installation. Linux users however are on their own. The minimum required version of Java is 11. We recommend installing Java from https://adoptopenjdk.net.

Downloads

Pipeline 1 Command Line Tool

To download the Pipeline Core packages: which you should use if you are running the Pipeline via the shell/command line, or as an embedded service:

DAISY Pipeline Core binaries (platform independent)

To get the sources and older versions visit Pipeline Core SourceForge Downloads

Pipeline 1 GUI

To download the latest version of Pipeline 1 20111215 with its cross-platform GUI:

See the release notes for more information and you can also visit the Pipeline GUI SourceForge Downloads to get older versions.

Installation

On Windows XP

Once you have downloaded DAISY Pipeline 1 GUI for Windows:

  1. Launch the downloaded installer: PipelineGUI-versiondate_setup.exe
  2. Follow the installation instructions.

On Mac OS X

Once you have downloaded DAISY Pipeline 1 GUI for Mac OS X:

  1. Mount the PipelineGUI-versiondate.dmg disk image (with double-click or cmd-down).
  2. Make sure to read the README file.
  3. Copy the DAISY Pipeline 1 application to the folder of your choice

Note: the disk image comes with an installer for the external utility tools used by some Pipeline transformers. If you want to install these tools, launch the External Tools installer and follow the instructions.

On Debian

Users of Debian or Debian-based distributions such as Ubuntu can install DAISY Pipeline via the ZIP file, but easier is to use the Debian package manager:

  1. Open a shell window
  2. Change to the directory where you have downloaded the DEB file
  3. Execute the following command:
dpkg -i daisy-pipeline2_x.y.z.deb

The Debian package includes the desktop application, the server and the command line tool.

On Red Hat

Users of Red Hat or other RPM-based distributions can install DAISY Pipeline via the ZIP file, but easier is to use the YUM package manager:

  1. Open a shell window,
  2. Change to the directory where you have downloaded the RPM file
  3. Execute the following command:
yum install daisy-pipeline2_x.y.z.rpm

The RPM package includes the desktop application, the server and the command line tool.

On Linux(es)

Once you have downloaded the DAISY Pipeline 1 GUI for Linux:

  1. Create a directory on your local file system where you want to install the application.
  2. Extract the content of the PipelineGUI-versiondate.tar.gz archive to the newly created directory.

Note: you may want to create a shortcut to the Pipeline executable for convenient access.

Guides are also available for installing:

On Docker

The Docker distribution is not available as a download on the website. It comes in the form of a Docker image that you can obtain via the Docker command line interface or as a specific version at https://hub.docker.com/r/daisyorg/pipeline-assembly/tags. After having pulled the image you’re ready to run the Pipeline web server:

The Pipeline web application is available as a Docker image too. You can find the available versions at https://hub.docker.com/r/daisyorg/pipeline-webui/tags.

For running more complex configurations like these, Docker compose is recommended.  Simply create a file called “docker-compose.yml” with the following content and run docker-compose up.

Updates

Some packages include an updater tool that you can use for quickly updating your current installation to the latest version. The updater can be invoked either via the desktop application or via the command line. The desktop application has a menu item Check updates under Help. On the command line it is different for each platform.

Configuration

Paths to third party executables are configurable in the Preferences dialog, in the Window menu item.

Note: on Windows and Mac OS X the installer takes care of setting the right paths and installing the required third party tools.

The paths that may be set are:

  • Temporary Directory—to store temporary files. This directory must be set, and write access to it must be enabled.
  • LAME executable—A path to the LAME executable which must be set if you want to run a script that includes MP3 encoding. Information on how to install LAME is available in Installing the Lame MP3 Encoder for use within the DAISY Pipeline
  • ImageMagick convert executable—A path to the ImageMagick convert executable which must be set if you intend to run the WordML to DTBook script with image conversions. Information on how to install ImageMagick is available in Installing ImageMagick for use within the DAISY Pipeline
  • SoX executable—A path to the SoX (Sound eXchange) executable used on Mac OS X for speech synthesis.

Advanced Configuration

Using a non-default Java virtual machine

In order to run DAISY Pipeline 1 using a non-default (not the one found on the system path) Java virtual machine (JRE), use the -vm [JRE path] command line parameter when starting the GUI.

Displaying the browser widget on Linux

If the browser widget used  for the DAISY Pipeline 1 GUI doesn’t work, it can be configured by following the instructions at eclipse.org.

Uninstalling the Pipeline

To uninstall Pipeline 1, simply delete the directory to which you extracted the Pipeline application archive during the installation process.

On Windows XP

Use the Pipeline 1 uninstaller available in the Pipeline installation directory.

On Mac OS X

Delete DAISY Pipeline 1 application from the applications directory.

On Linux(es)

Delete the directory to which you extracted Pipeline 1 application archive during the installation process.