-
Notifications
You must be signed in to change notification settings - Fork 21
Installation
Start by downloading DAISY Pipeline from the downloads page. You can choose from different packages. DAISY Pipeline consists of several components (explained here). Check whether the package you are downloading includes the component you wish to install. Also, there are different downloads for different platforms.
These are the installation instructions for each package. Before starting with the installation make sure the system requirements are fulfilled.
For Windows users there is the Windows installer. It automatically installs the desktop application, the server and the command line tool. Simply launch the installer and follow the instructions on the screen.
For Mac OS users there is the disk image. It contains the desktop application. To install, open the image and drag the application file to the "Applications" folder, or any other destination you want.
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. Open a shell window, change to the directory where you have downloaded the DEB file, then 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.
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. Open a shell window, change to the directory where you have downloaded the RPM file, then 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.
The ZIP can be installed on all Linux distros. It includes the desktop application, the server and the command line tool. To install, simply extract the contents to any destination you want.
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:
docker pull daisyorg/pipeline
It is also possible to get a specific version:
docker pull daisyorg/pipeline:<version>
or to get the latest development version:
docker pull daisyorg/pipeline:latest-snapshot
You can find the available versions at https://hub.docker.com/r/daisyorg/pipeline/tags. After having pulled the image you're ready to run the Pipeline web server:
docker run --detach \
-p 8181:8181 \
-e PIPELINE2_WS_HOST=0.0.0.0 \
daisyorg/pipeline
This will make the web service available on the address
http://localhost:8181/ws. By default, authentication is enabled. The
key and secret are "clientid" and
"sekret". Environment variables
can be provided with one or more -e
arguments.
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.
docker pull daisyorg/pipeline-webui
The application is launched as follows. This assumes the web server is already started and accessible on port 8181.
docker run --detach \
-p 9000:9000 \
daisyorg/pipeline-webui
It is also possible to link the two containers without exposing the web service to the host:
docker run --detach \
--name pipeline \
-e PIPELINE2_WS_HOST=0.0.0.0 \
-e PIPELINE2_WS_AUTHENTICATION=false \
daisyorg/pipeline
docker run --detach \
--link pipeline \
-p 9000:9000 \
-e DAISY_PIPELINE2_URL=http://pipeline:8181/ws \
daisyorg/pipeline-webui
For running more complex configurations like these,
Docker compose is recommended. A
complete example, that also persists the application data, is given
below. Simply create a file called "docker-compose.yml" with the
following content and run docker-compose up
.
version: "2.1"
services:
pipeline:
image: daisyorg/pipeline
environment:
PIPELINE2_WS_HOST: "0.0.0.0"
PIPELINE2_WS_AUTHENTICATION: "false"
volumes:
- "pipeline-data:/opt/daisy-pipeline2/data"
webui:
image: daisyorg/pipeline-webui
environment:
DAISY_PIPELINE2_URL: http://pipeline:8181/ws
ports:
- "9000:9000"
volumes:
- "webui-data:/opt/daisy-pipeline2-webui/data"
depends_on:
pipeline:
condition: service_healthy
volumes:
pipeline-data:
webui-data:
To learn more about Docker see https://docs.docker.com.
Some packages also 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.
/Applications/DAISY\ Pipeline\ 2.app/Contents/Java/updater/pipeline-updater \
-service="http://daisy.github.io/pipeline-assembly/releases/" \
-install-dir="/Applications/DAISY Pipeline 2.app/Contents/Java/" \
-descriptor="/Applications/DAISY Pipeline 2.app/Contents/Java/etc/releaseDescriptor.xml" \
-version=current
In the above command replace "/Applications" with whichever directory you have installed the application file in.
/home/bert/pipeline2/updater/pipeline-updater \
-service="http://daisy.github.io/pipeline-assembly/releases/" \
-install-dir=/home/bert/pipeline2/ \
-descriptor=/home/bert/pipeline2/etc/releaseDescriptor.xml \
-version=current
In the above command replace "/home/bert/pipeline2" with whichever directory you have unpacked the ZIP file to.
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://adoptium.net/.
- Home
- Download
-
Help
-
User Guide
- Installation
- Desktop Application
- Web Application
- Pipeline as a Service
- Command Line
-
Scripts
- DAISY 2.02 Validator
- DAISY 2.02 to EPUB 3
- DAISY 3 to DAISY 2.02
- DAISY 3 to EPUB 3
- DTBook Validator
- DTBook to DAISY 3
- DTBook to EPUB3
- DTBook to HTML
- DTBook to ODT
- DTBook to PEF
- DTBook to RTF
- DTBook to ZedAI
- EPUB 2 to EPUB 3
- EPUB 3 Enhancer
- EPUB 3 Validator
- EPUB 3 to DAISY 2.02
- EPUB 3 to DAISY 3
- EPUB 3 to PEF
- EPUB to DAISY
- HTML to DTBook
- HTML to EPUB3
- HTML to PEF
- NIMAS Fileset Validator
- ZedAI to EPUB 3
- ZedAI to HTML
- ZedAI to PEF
- API Documentation
- Issue Tracker
- Troubleshooting
- Forum
- [[Contact|mailto:[email protected]]]
-
User Guide
- Contribute
- DAISY Home