The Pipes image is a lightweight Java container, built on openjdk:8-jdk-alpine.

For more information about the Pipes project and the technologies referred to in this guide, please see:

• Pipes

• MarkLogic Data Hub Framework (DHF)

• Gradle

• Create a DHF project using Gradle

• Docker networking

Before following the instructions below, please make sure:

• You have the MarkLogic image from DockerHub on your local machine.

• You have a Data Hub Framework (DHF) project on your local machine.

  • In this project, you need to have added the Pipes mlBundle to your DHF build.gradle file (see the main Pipes documentation for more information)

The Pipes image is hosted on DockerHub. Assuming you already have a DockerHub account, first make sure you are logged in.

docker login

Then, enter your credentials (if necessary).

Next, pull the image:

docker pull dhfpipes/pipes:v1

If you would like to build the image yourself, please follow the instructions in building-pipes-image.md.

To run both Pipes and MarkLogic DHF in containers, we recommend using Docker Compose. The following instructions use the Docker Compose files in this project.

Create a file called .env (that's right, just .env). This file contains the values your containers will use. You can use the example.env file for reference. You can use most of the default values from example.env, but will need to change:

• mlAdmin (your MarkLogic username)

• mlPassword (your MarkLogic password)

• mlVersion (the version of the MarkLogic image that's on your machine)

• DHFfiles (the directory that contains your DHF project)

docker-compose -f marklogic.yml up

After a few minutes the terminal output will stop and MarkLogic will have been installed and initiated. To check, log-in to your MarkLogic instance (e.g., localhost:8000) with the username and password you set in the .env file.

Open a new terminal window. Change directory to the location of your DHF project (this will be the directory you set the DHFfile property to in the .env file).

./gradlew mlDeploy

Gradle will deploy the DHF to your MarkLogic container, via localhost, using the port-binding you specified in the .env file.

Opening another terminal, change directory to the location that contains your Docker Compose files (where you started the MarkLogic container from).

docker-compose -f pipes.yml up

You should now have MarkLogic and Pipes running in containers and available via the bound ports. For example, at localhost:8000 and localhost:9081.